@alpic-ai/api 0.0.0-staging.g0d29488 → 0.0.0-staging.g0dcbde4
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 +5433 -145
- package/dist/index.mjs +537 -125
- 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.0_supports-color@7.2.0_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),
|
|
@@ -400,9 +431,10 @@ z.object({
|
|
|
400
431
|
collectResponsePayload: z.boolean(),
|
|
401
432
|
collectErrorMessage: z.boolean(),
|
|
402
433
|
collectUserData: z.boolean(),
|
|
403
|
-
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
434
|
+
identityTraitKey: z.string().min(1).max(200).nullable(),
|
|
435
|
+
leadEventName: z.string().min(1).max(200).nullable()
|
|
404
436
|
});
|
|
405
|
-
z.object({
|
|
437
|
+
const feedbackSchema = z.object({
|
|
406
438
|
id: z.string(),
|
|
407
439
|
createdAt: z.coerce.date(),
|
|
408
440
|
environmentId: z.string(),
|
|
@@ -424,7 +456,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
424
456
|
"pink",
|
|
425
457
|
"gray"
|
|
426
458
|
]);
|
|
427
|
-
intentCategoryColorSchema.options;
|
|
459
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
428
460
|
const intentCategorySchema = z.object({
|
|
429
461
|
id: z.string(),
|
|
430
462
|
createdAt: z.coerce.date(),
|
|
@@ -432,7 +464,7 @@ const intentCategorySchema = z.object({
|
|
|
432
464
|
name: z.string(),
|
|
433
465
|
color: intentCategoryColorSchema
|
|
434
466
|
});
|
|
435
|
-
z.object({
|
|
467
|
+
const intentCategorySummarySchema = z.object({
|
|
436
468
|
id: z.string(),
|
|
437
469
|
name: z.string(),
|
|
438
470
|
color: intentCategoryColorSchema,
|
|
@@ -503,12 +535,30 @@ z.object({
|
|
|
503
535
|
createdAt: z.coerce.date(),
|
|
504
536
|
updatedAt: z.coerce.date()
|
|
505
537
|
});
|
|
538
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
539
|
+
type: z.literal("mcp_request"),
|
|
540
|
+
method: z.string()
|
|
541
|
+
});
|
|
542
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
543
|
+
type: z.literal("mcp_error"),
|
|
544
|
+
method: z.string(),
|
|
545
|
+
error: z.string()
|
|
546
|
+
});
|
|
547
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
506
548
|
z.enum([
|
|
507
549
|
"INFO",
|
|
508
550
|
"WARNING",
|
|
509
551
|
"DEBUG",
|
|
510
552
|
"ERROR"
|
|
511
553
|
]);
|
|
554
|
+
const LOG_SEARCH_MAX_ESCAPED_LENGTH = 960;
|
|
555
|
+
function escapeLogSearchTerm(search) {
|
|
556
|
+
return [...search].flatMap((character) => [...new TextEncoder().encode(character)]).map((byte) => {
|
|
557
|
+
const character = String.fromCharCode(byte);
|
|
558
|
+
return /^[a-zA-Z0-9]$/.test(character) ? character : `\\x${byte.toString(16).toUpperCase().padStart(2, "0")}`;
|
|
559
|
+
}).join("");
|
|
560
|
+
}
|
|
561
|
+
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");
|
|
512
562
|
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
513
563
|
const MCP_CLIENT_GROUPS = [
|
|
514
564
|
{
|
|
@@ -834,6 +884,10 @@ const clampStringField = (field) => {
|
|
|
834
884
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
835
885
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
836
886
|
};
|
|
887
|
+
const unboundedArrayField = (field) => {
|
|
888
|
+
const unbounded = z.array(field.element);
|
|
889
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
890
|
+
};
|
|
837
891
|
const toolDefinitionSchema = z.object({
|
|
838
892
|
name: z.string(),
|
|
839
893
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -846,11 +900,22 @@ const toolDefinitionSchema = z.object({
|
|
|
846
900
|
}).optional()
|
|
847
901
|
});
|
|
848
902
|
const positiveTestCaseSchema = z.object({
|
|
849
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
850
|
-
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."),
|
|
903
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
904
|
+
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."),
|
|
851
905
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
852
906
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
853
|
-
}).
|
|
907
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
908
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
909
|
+
scenario: z.string().optional(),
|
|
910
|
+
userPrompt: z.string().optional()
|
|
911
|
+
});
|
|
912
|
+
const blankPositiveTestCase = () => ({
|
|
913
|
+
scenario: "",
|
|
914
|
+
userPrompt: "",
|
|
915
|
+
toolTriggered: "",
|
|
916
|
+
expectedOutput: ""
|
|
917
|
+
});
|
|
918
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
854
919
|
const screenshotEntrySchema = z.object({
|
|
855
920
|
prompt: z.string(),
|
|
856
921
|
url: z.url()
|
|
@@ -1163,9 +1228,18 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
1163
1228
|
"zh-TW"
|
|
1164
1229
|
]);
|
|
1165
1230
|
const negativeTestCaseSchema = z.object({
|
|
1166
|
-
scenario: z.string(),
|
|
1167
|
-
userPrompt: z.string()
|
|
1168
|
-
}).
|
|
1231
|
+
scenario: z.string().min(1),
|
|
1232
|
+
userPrompt: z.string().min(1)
|
|
1233
|
+
}).describe("Each case: Scenario + User prompt (the plugin should NOT trigger).");
|
|
1234
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1235
|
+
scenario: z.string().optional(),
|
|
1236
|
+
userPrompt: z.string().optional()
|
|
1237
|
+
});
|
|
1238
|
+
const blankNegativeTestCase = () => ({
|
|
1239
|
+
scenario: "",
|
|
1240
|
+
userPrompt: ""
|
|
1241
|
+
});
|
|
1242
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
1169
1243
|
const chatgptToolJustificationSchema = z.object({
|
|
1170
1244
|
toolName: z.string(),
|
|
1171
1245
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
@@ -1185,27 +1259,28 @@ chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema
|
|
|
1185
1259
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
1186
1260
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
1187
1261
|
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."),
|
|
1188
|
-
appName: z.string().describe("The name users will see in ChatGPT and in the
|
|
1262
|
+
appName: z.string().describe("The name users will see in ChatGPT and in the Plugin Directory."),
|
|
1189
1263
|
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
1190
|
-
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the
|
|
1264
|
+
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)."),
|
|
1191
1265
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
1192
|
-
developerName: z.string().describe("Developer name shown publicly on the
|
|
1266
|
+
developerName: z.string().describe("Developer name shown publicly on the plugin's directory page."),
|
|
1193
1267
|
companyUrl: urlField.describe("Your company's main website URL."),
|
|
1194
1268
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
1195
1269
|
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1196
|
-
termsOfServiceUrl: urlField.describe("URL to the
|
|
1197
|
-
demoRecordingUrl: urlField.describe("URL to a video demonstrating the
|
|
1198
|
-
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My
|
|
1270
|
+
termsOfServiceUrl: urlField.describe("URL to the plugin's terms of service."),
|
|
1271
|
+
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."),
|
|
1272
|
+
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."),
|
|
1199
1273
|
serverUrl: urlField.describe("URL of the MCP server."),
|
|
1200
1274
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
1201
1275
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1202
1276
|
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."),
|
|
1203
|
-
|
|
1204
|
-
|
|
1205
|
-
|
|
1277
|
+
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."),
|
|
1278
|
+
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."),
|
|
1279
|
+
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."),
|
|
1280
|
+
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."),
|
|
1206
1281
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1207
1282
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
1208
|
-
releaseNotes: z.string().describe("Publicly displayed on the
|
|
1283
|
+
releaseNotes: z.string().describe("Publicly displayed on the plugin details page.")
|
|
1209
1284
|
});
|
|
1210
1285
|
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1211
1286
|
tagline: z.string().optional(),
|
|
@@ -1216,23 +1291,35 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
1216
1291
|
demoRecordingUrl: z.string().optional(),
|
|
1217
1292
|
serverUrl: z.string().optional(),
|
|
1218
1293
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1294
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1295
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1219
1296
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1220
1297
|
});
|
|
1221
|
-
|
|
1298
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1299
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1222
1300
|
appName: true,
|
|
1223
1301
|
developerName: true,
|
|
1224
1302
|
serverUrl: true,
|
|
1225
1303
|
tools: true,
|
|
1304
|
+
skills: true,
|
|
1226
1305
|
authentication: true
|
|
1227
1306
|
});
|
|
1228
|
-
|
|
1307
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1308
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1229
1309
|
tagline: true,
|
|
1230
1310
|
description: true,
|
|
1231
1311
|
category: true,
|
|
1232
1312
|
testCases: true,
|
|
1233
1313
|
negativeTestCases: true,
|
|
1234
1314
|
toolJustifications: true
|
|
1235
|
-
}).extend({
|
|
1315
|
+
}).extend({
|
|
1316
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1317
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1318
|
+
}).extend({
|
|
1319
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1320
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1321
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1322
|
+
});
|
|
1236
1323
|
const claudeCategorySchema = z.enum([
|
|
1237
1324
|
"Productivity",
|
|
1238
1325
|
"Communication",
|
|
@@ -1355,7 +1442,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1355
1442
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1356
1443
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1357
1444
|
});
|
|
1358
|
-
|
|
1445
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1446
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1359
1447
|
serverUrl: true,
|
|
1360
1448
|
name: true,
|
|
1361
1449
|
slug: true,
|
|
@@ -1377,27 +1465,86 @@ const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
|
1377
1465
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1378
1466
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1379
1467
|
});
|
|
1380
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1468
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1381
1469
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1382
1470
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1383
1471
|
});
|
|
1472
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1473
|
+
const byField = {};
|
|
1474
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1475
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1476
|
+
return byField;
|
|
1477
|
+
}
|
|
1478
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1479
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1480
|
+
"pass",
|
|
1481
|
+
"fail",
|
|
1482
|
+
"unverified"
|
|
1483
|
+
]);
|
|
1484
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1485
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1486
|
+
claudeai: ["privacyPolicy"]
|
|
1487
|
+
};
|
|
1488
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1489
|
+
const policyDisclosureSchema = z.enum([
|
|
1490
|
+
"dataCategories",
|
|
1491
|
+
"purposesOfUse",
|
|
1492
|
+
"recipients",
|
|
1493
|
+
"retention"
|
|
1494
|
+
]);
|
|
1495
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1496
|
+
field: verifiableUrlFieldSchema,
|
|
1497
|
+
url: z.string(),
|
|
1498
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1499
|
+
reason: z.string(),
|
|
1500
|
+
concerns: z.array(z.string()).optional(),
|
|
1501
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1502
|
+
});
|
|
1503
|
+
const urlVerificationSchema = z.object({
|
|
1504
|
+
verifiedAt: z.coerce.date(),
|
|
1505
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1506
|
+
});
|
|
1507
|
+
const pageKindSchema = z.enum([
|
|
1508
|
+
"expectedDocument",
|
|
1509
|
+
"errorPage",
|
|
1510
|
+
"loginWall",
|
|
1511
|
+
"parkedDomain",
|
|
1512
|
+
"comingSoon",
|
|
1513
|
+
"marketingPage",
|
|
1514
|
+
"unrelatedDocument"
|
|
1515
|
+
]);
|
|
1516
|
+
z.object({
|
|
1517
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1518
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1519
|
+
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.")
|
|
1520
|
+
});
|
|
1384
1521
|
const submissionMetaFieldsSchema = z.object({
|
|
1385
1522
|
id: z.string(),
|
|
1386
1523
|
environmentId: z.string(),
|
|
1387
1524
|
auditId: z.string().nullable(),
|
|
1525
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1388
1526
|
createdAt: z.coerce.date(),
|
|
1389
1527
|
updatedAt: z.coerce.date()
|
|
1390
1528
|
});
|
|
1391
1529
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1392
1530
|
platform: z.literal("claudeai"),
|
|
1393
|
-
formData: claudeSubmissionDraftSchema
|
|
1531
|
+
formData: claudeSubmissionDraftSchema,
|
|
1532
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1394
1533
|
});
|
|
1395
1534
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1396
1535
|
platform: z.literal("chatgpt"),
|
|
1397
|
-
formData: chatgptSubmissionDraftSchema
|
|
1536
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1537
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1398
1538
|
});
|
|
1399
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1539
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1400
1540
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1541
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1542
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1543
|
+
z.literal([
|
|
1544
|
+
100,
|
|
1545
|
+
75,
|
|
1546
|
+
50
|
|
1547
|
+
]);
|
|
1401
1548
|
const subscriptionPlanSchema = z.enum([
|
|
1402
1549
|
"pro",
|
|
1403
1550
|
"business",
|
|
@@ -1409,17 +1556,72 @@ const customerCreditsSchema = z.object({
|
|
|
1409
1556
|
expiresAt: z.number().nullable(),
|
|
1410
1557
|
currency: z.string()
|
|
1411
1558
|
});
|
|
1412
|
-
const customerUsageSchema = z.object({
|
|
1413
|
-
amountInCents: z.number(),
|
|
1414
|
-
currency: z.string(),
|
|
1415
|
-
periodEnd: z.number()
|
|
1416
|
-
});
|
|
1417
1559
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1418
1560
|
z.object({
|
|
1419
1561
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1420
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1421
1562
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1422
1563
|
});
|
|
1564
|
+
const metricsQueueEventSchema = z.object({
|
|
1565
|
+
ts: z.number().int(),
|
|
1566
|
+
method: z.string(),
|
|
1567
|
+
tool: z.string().nullable(),
|
|
1568
|
+
client: z.string(),
|
|
1569
|
+
sessionId: z.string().nullable(),
|
|
1570
|
+
conversationId: z.string().nullable().optional(),
|
|
1571
|
+
durationMs: z.number().int(),
|
|
1572
|
+
outputTokens: z.number().int().nullable(),
|
|
1573
|
+
errorType: z.enum([
|
|
1574
|
+
"mcp_error",
|
|
1575
|
+
"tool_error",
|
|
1576
|
+
"timeout"
|
|
1577
|
+
]).nullable(),
|
|
1578
|
+
errorCode: z.number().int().nullable()
|
|
1579
|
+
});
|
|
1580
|
+
z.object({
|
|
1581
|
+
v: z.literal(1),
|
|
1582
|
+
envId: z.string(),
|
|
1583
|
+
events: z.array(metricsQueueEventSchema)
|
|
1584
|
+
});
|
|
1585
|
+
z.object({ v: z.number() });
|
|
1586
|
+
const telemetrySignalSchema = z.enum([
|
|
1587
|
+
"logs",
|
|
1588
|
+
"metrics",
|
|
1589
|
+
"traces"
|
|
1590
|
+
]);
|
|
1591
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1592
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1593
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1594
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1595
|
+
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");
|
|
1596
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1597
|
+
id: z.string(),
|
|
1598
|
+
name: otlpHeaderNameSchema,
|
|
1599
|
+
value: otlpHeaderValueSchema,
|
|
1600
|
+
isSecret: z.boolean()
|
|
1601
|
+
});
|
|
1602
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1603
|
+
"credentials",
|
|
1604
|
+
"wrong-path",
|
|
1605
|
+
"wrong-protocol",
|
|
1606
|
+
"invalid-payload",
|
|
1607
|
+
"partial-rejection",
|
|
1608
|
+
"blocked-target",
|
|
1609
|
+
"timeout",
|
|
1610
|
+
"unreachable",
|
|
1611
|
+
"receiver-error",
|
|
1612
|
+
"unexpected-status"
|
|
1613
|
+
]);
|
|
1614
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1615
|
+
z.object({
|
|
1616
|
+
id: z.string(),
|
|
1617
|
+
signal: telemetrySignalSchema,
|
|
1618
|
+
endpoint: otlpEndpointSchema,
|
|
1619
|
+
protocol: otlpProtocolSchema,
|
|
1620
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1621
|
+
status: telemetryDestinationStatusSchema,
|
|
1622
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable(),
|
|
1623
|
+
isScopedToIntentionalRequestsOnly: z.boolean()
|
|
1624
|
+
});
|
|
1423
1625
|
//#endregion
|
|
1424
1626
|
//#region src/auth-scope.ts
|
|
1425
1627
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1518,6 +1720,14 @@ const serverFieldsSchema = z.object({
|
|
|
1518
1720
|
});
|
|
1519
1721
|
//#endregion
|
|
1520
1722
|
//#region src/api.contract.ts
|
|
1723
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1724
|
+
try {
|
|
1725
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1726
|
+
return true;
|
|
1727
|
+
} catch {
|
|
1728
|
+
return false;
|
|
1729
|
+
}
|
|
1730
|
+
};
|
|
1521
1731
|
const deploymentStatusSchema = z.enum([
|
|
1522
1732
|
"ongoing",
|
|
1523
1733
|
"deployed",
|
|
@@ -1546,21 +1756,20 @@ const deploymentSchema = z.object({
|
|
|
1546
1756
|
isCurrent: z.boolean(),
|
|
1547
1757
|
deploymentPageUrl: z.url().nullable()
|
|
1548
1758
|
});
|
|
1549
|
-
const
|
|
1759
|
+
const isValidTimeInput = (value) => {
|
|
1550
1760
|
if (ms(value) !== void 0) return true;
|
|
1551
1761
|
return !Number.isNaN(new Date(value).getTime());
|
|
1552
1762
|
};
|
|
1553
|
-
const
|
|
1763
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1764
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1765
|
+
const createEnvironmentContractV1 = base.route({
|
|
1554
1766
|
path: "/v1/environments",
|
|
1555
1767
|
method: "POST",
|
|
1556
1768
|
summary: "Create an environment",
|
|
1557
1769
|
description: "Create an environment for a project",
|
|
1558
1770
|
tags: ["environments"],
|
|
1559
1771
|
successDescription: "The environment has been created successfully"
|
|
1560
|
-
}).errors({
|
|
1561
|
-
NOT_FOUND: {},
|
|
1562
|
-
BAD_REQUEST: {}
|
|
1563
|
-
}).input(z.object({
|
|
1772
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1564
1773
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1565
1774
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1566
1775
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1573,7 +1782,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1573
1782
|
createdAt: z.coerce.date(),
|
|
1574
1783
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1575
1784
|
}));
|
|
1576
|
-
const getEnvironmentContractV1 =
|
|
1785
|
+
const getEnvironmentContractV1 = base.route({
|
|
1577
1786
|
path: "/v1/environments/{environmentId}",
|
|
1578
1787
|
method: "GET",
|
|
1579
1788
|
summary: "Get an environment",
|
|
@@ -1589,6 +1798,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1589
1798
|
createdAt: z.coerce.date(),
|
|
1590
1799
|
projectId: z.string()
|
|
1591
1800
|
}));
|
|
1801
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1802
|
+
path: "/v1/environments/{environmentId}",
|
|
1803
|
+
method: "DELETE",
|
|
1804
|
+
summary: "Delete an environment",
|
|
1805
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1806
|
+
tags: ["environments"],
|
|
1807
|
+
successDescription: "The environment has been deleted successfully"
|
|
1808
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1592
1809
|
const domainSchema = z.object({
|
|
1593
1810
|
domain: z.string(),
|
|
1594
1811
|
status: z.enum([
|
|
@@ -1630,7 +1847,7 @@ const projectOutputSchema = z.object({
|
|
|
1630
1847
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1631
1848
|
environments: z.array(environmentSchema)
|
|
1632
1849
|
});
|
|
1633
|
-
const getProjectContractV1 =
|
|
1850
|
+
const getProjectContractV1 = base.route({
|
|
1634
1851
|
path: "/v1/projects/{projectId}",
|
|
1635
1852
|
method: "GET",
|
|
1636
1853
|
summary: "Get a project",
|
|
@@ -1638,18 +1855,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1638
1855
|
tags: ["projects"],
|
|
1639
1856
|
successDescription: "The project details"
|
|
1640
1857
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1641
|
-
const listProjectsContractV1 =
|
|
1858
|
+
const listProjectsContractV1 = base.route({
|
|
1642
1859
|
path: "/v1/projects",
|
|
1643
1860
|
method: "GET",
|
|
1644
1861
|
summary: "List projects",
|
|
1645
1862
|
description: "List all projects for a team",
|
|
1646
1863
|
tags: ["projects"],
|
|
1647
1864
|
successDescription: "The list of projects"
|
|
1648
|
-
}).errors({
|
|
1649
|
-
|
|
1650
|
-
BAD_REQUEST: {}
|
|
1651
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1652
|
-
const createProjectContractV1 = oc.route({
|
|
1865
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1866
|
+
const createProjectContractV1 = base.route({
|
|
1653
1867
|
path: "/v1/projects",
|
|
1654
1868
|
method: "POST",
|
|
1655
1869
|
summary: "Create a project",
|
|
@@ -1658,7 +1872,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1658
1872
|
successDescription: "The project has been created successfully"
|
|
1659
1873
|
}).errors({
|
|
1660
1874
|
NOT_FOUND: {},
|
|
1661
|
-
BAD_REQUEST: {},
|
|
1662
1875
|
FORBIDDEN: {}
|
|
1663
1876
|
}).input(z.object({
|
|
1664
1877
|
teamId: z.string().optional(),
|
|
@@ -1699,7 +1912,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1699
1912
|
isSecret: z.boolean(),
|
|
1700
1913
|
createdAt: z.coerce.date()
|
|
1701
1914
|
});
|
|
1702
|
-
const listEnvironmentVariablesContractV1 =
|
|
1915
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1703
1916
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1704
1917
|
method: "GET",
|
|
1705
1918
|
summary: "List environment variables",
|
|
@@ -1707,48 +1920,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1707
1920
|
tags: ["environments"],
|
|
1708
1921
|
successDescription: "The list of environment variables"
|
|
1709
1922
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1710
|
-
const createEnvironmentVariablesContractV1 =
|
|
1923
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1711
1924
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1712
1925
|
method: "POST",
|
|
1713
1926
|
summary: "Add environment variables",
|
|
1714
1927
|
description: "Add one or more environment variables to an environment",
|
|
1715
1928
|
tags: ["environments"],
|
|
1716
1929
|
successDescription: "The environment variables have been added successfully"
|
|
1717
|
-
}).errors({
|
|
1718
|
-
NOT_FOUND: {},
|
|
1719
|
-
BAD_REQUEST: {}
|
|
1720
|
-
}).input(z.object({
|
|
1930
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1721
1931
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1722
1932
|
environmentVariables: environmentVariablesSchema
|
|
1723
1933
|
})).output(z.object({ success: z.literal(true) }));
|
|
1724
|
-
const updateEnvironmentVariableContractV1 =
|
|
1934
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1725
1935
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1726
1936
|
method: "PATCH",
|
|
1727
1937
|
summary: "Update an environment variable",
|
|
1728
1938
|
description: "Update an environment variable by ID",
|
|
1729
1939
|
tags: ["environments"],
|
|
1730
1940
|
successDescription: "The environment variable has been updated successfully"
|
|
1731
|
-
}).errors({
|
|
1732
|
-
NOT_FOUND: {},
|
|
1733
|
-
BAD_REQUEST: {}
|
|
1734
|
-
}).input(z.object({
|
|
1941
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1735
1942
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1736
1943
|
key: environmentVariableSchema.shape.key,
|
|
1737
1944
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1738
1945
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1739
1946
|
})).output(z.object({ success: z.literal(true) }));
|
|
1740
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1947
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1741
1948
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1742
1949
|
method: "DELETE",
|
|
1743
1950
|
summary: "Delete an environment variable",
|
|
1744
1951
|
description: "Delete an environment variable by ID",
|
|
1745
1952
|
tags: ["environments"],
|
|
1746
1953
|
successDescription: "The environment variable has been deleted successfully"
|
|
1747
|
-
}).errors({
|
|
1748
|
-
|
|
1749
|
-
BAD_REQUEST: {}
|
|
1750
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1751
|
-
const deleteProjectContractV1 = oc.route({
|
|
1954
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1955
|
+
const deleteProjectContractV1 = base.route({
|
|
1752
1956
|
path: "/v1/projects/{projectId}",
|
|
1753
1957
|
method: "DELETE",
|
|
1754
1958
|
summary: "Delete a project",
|
|
@@ -1756,7 +1960,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1756
1960
|
tags: ["projects"],
|
|
1757
1961
|
successDescription: "The project has been deleted successfully"
|
|
1758
1962
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1759
|
-
const updateProjectContractV1 =
|
|
1963
|
+
const updateProjectContractV1 = base.route({
|
|
1760
1964
|
path: "/v1/projects/{projectId}",
|
|
1761
1965
|
method: "PATCH",
|
|
1762
1966
|
summary: "Update a project",
|
|
@@ -1765,14 +1969,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1765
1969
|
successDescription: "The project has been updated successfully"
|
|
1766
1970
|
}).errors({
|
|
1767
1971
|
NOT_FOUND: {},
|
|
1768
|
-
BAD_REQUEST: {},
|
|
1769
1972
|
FORBIDDEN: {}
|
|
1770
1973
|
}).input(z.object({
|
|
1771
1974
|
projectId: z.string().describe("The ID of the project"),
|
|
1772
1975
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1773
1976
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1774
1977
|
})).output(projectOutputSchema);
|
|
1775
|
-
const deployEnvironmentContractV1 =
|
|
1978
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1776
1979
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1777
1980
|
method: "POST",
|
|
1778
1981
|
summary: "Deploy an environment",
|
|
@@ -1781,29 +1984,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1781
1984
|
successDescription: "The environment has been deployed successfully"
|
|
1782
1985
|
}).errors({
|
|
1783
1986
|
NOT_FOUND: {},
|
|
1784
|
-
BAD_REQUEST: {},
|
|
1785
1987
|
CONFLICT: {}
|
|
1786
1988
|
}).input(z.object({
|
|
1787
1989
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1788
1990
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1789
1991
|
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.")
|
|
1790
1992
|
})).output(deploymentSchema);
|
|
1791
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1993
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1792
1994
|
path: "/v1/deployments/upload",
|
|
1793
1995
|
method: "POST",
|
|
1794
1996
|
summary: "Upload deployment artifacts",
|
|
1795
1997
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1796
1998
|
tags: ["deployments"],
|
|
1797
1999
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1798
|
-
}).errors({
|
|
1799
|
-
NOT_FOUND: {},
|
|
1800
|
-
BAD_REQUEST: {}
|
|
1801
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
2000
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1802
2001
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1803
2002
|
token: z.string().describe("Token to identify the source archive"),
|
|
1804
2003
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1805
2004
|
}));
|
|
1806
|
-
const listDeploymentsContractV1 =
|
|
2005
|
+
const listDeploymentsContractV1 = base.route({
|
|
1807
2006
|
path: "/v1/projects/{projectId}/deployments",
|
|
1808
2007
|
method: "GET",
|
|
1809
2008
|
summary: "List project deployments",
|
|
@@ -1815,7 +2014,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1815
2014
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1816
2015
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1817
2016
|
})).output(z.array(deploymentSchema));
|
|
1818
|
-
const getDeploymentContractV1 =
|
|
2017
|
+
const getDeploymentContractV1 = base.route({
|
|
1819
2018
|
path: "/v1/deployments/{deploymentId}",
|
|
1820
2019
|
method: "GET",
|
|
1821
2020
|
summary: "Get a deployment",
|
|
@@ -1838,20 +2037,17 @@ const logEntrySchema = z.object({
|
|
|
1838
2037
|
method: z.string().optional(),
|
|
1839
2038
|
durationInMs: z.number().optional()
|
|
1840
2039
|
});
|
|
1841
|
-
const getLogsContractV1 =
|
|
2040
|
+
const getLogsContractV1 = base.route({
|
|
1842
2041
|
path: "/v1/environments/{environmentId}/logs",
|
|
1843
2042
|
method: "GET",
|
|
1844
2043
|
summary: "Get logs",
|
|
1845
2044
|
description: "Get logs for an environment",
|
|
1846
2045
|
tags: ["environments"],
|
|
1847
2046
|
successDescription: "The logs"
|
|
1848
|
-
}).errors({
|
|
1849
|
-
NOT_FOUND: {},
|
|
1850
|
-
BAD_REQUEST: {}
|
|
1851
|
-
}).input(z.object({
|
|
2047
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1852
2048
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1853
|
-
since:
|
|
1854
|
-
until:
|
|
2049
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2050
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1855
2051
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1856
2052
|
level: z.array(z.enum([
|
|
1857
2053
|
"INFO",
|
|
@@ -1859,23 +2055,20 @@ const getLogsContractV1 = oc.route({
|
|
|
1859
2055
|
"WARNING",
|
|
1860
2056
|
"DEBUG"
|
|
1861
2057
|
])).optional().describe("Filter by log level"),
|
|
1862
|
-
search:
|
|
2058
|
+
search: logSearchSchema.optional().describe("Term to search for in log content"),
|
|
1863
2059
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1864
2060
|
})).output(z.object({
|
|
1865
2061
|
logs: z.array(logEntrySchema),
|
|
1866
2062
|
nextToken: z.string().nullable()
|
|
1867
2063
|
}));
|
|
1868
|
-
const getLatestLogsContractV1 =
|
|
2064
|
+
const getLatestLogsContractV1 = base.route({
|
|
1869
2065
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1870
2066
|
method: "GET",
|
|
1871
2067
|
summary: "Get latest logs",
|
|
1872
2068
|
description: "Get the N most recent logs for an environment",
|
|
1873
2069
|
tags: ["environments"],
|
|
1874
2070
|
successDescription: "The latest logs"
|
|
1875
|
-
}).errors({
|
|
1876
|
-
NOT_FOUND: {},
|
|
1877
|
-
BAD_REQUEST: {}
|
|
1878
|
-
}).input(z.object({
|
|
2071
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1879
2072
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1880
2073
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1881
2074
|
level: z.array(z.enum([
|
|
@@ -1884,9 +2077,9 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1884
2077
|
"WARNING",
|
|
1885
2078
|
"DEBUG"
|
|
1886
2079
|
])).optional().describe("Filter by log level"),
|
|
1887
|
-
search:
|
|
2080
|
+
search: logSearchSchema.optional().describe("Term to search for in log content")
|
|
1888
2081
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1889
|
-
const getDeploymentLogsContractV1 =
|
|
2082
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1890
2083
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1891
2084
|
method: "GET",
|
|
1892
2085
|
summary: "Get deployment logs",
|
|
@@ -1913,22 +2106,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1913
2106
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1914
2107
|
task_count: z.array(analyticsDataPointSchema)
|
|
1915
2108
|
});
|
|
1916
|
-
const getProjectAnalyticsContractV1 =
|
|
2109
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1917
2110
|
path: "/v1/analytics/{projectId}",
|
|
1918
2111
|
method: "GET",
|
|
1919
2112
|
summary: "Get project analytics",
|
|
1920
2113
|
description: "Get analytics data for a project over a time range",
|
|
1921
2114
|
tags: ["analytics"],
|
|
1922
2115
|
successDescription: "The project analytics data"
|
|
1923
|
-
}).errors({
|
|
1924
|
-
NOT_FOUND: {},
|
|
1925
|
-
BAD_REQUEST: {}
|
|
1926
|
-
}).input(z.object({
|
|
2116
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1927
2117
|
projectId: z.string().describe("The ID of the project"),
|
|
1928
2118
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1929
2119
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1930
2120
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1931
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2121
|
+
}).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({
|
|
1932
2122
|
metadata: z.object({
|
|
1933
2123
|
startTimestamp: z.number(),
|
|
1934
2124
|
endTimestamp: z.number(),
|
|
@@ -1938,7 +2128,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1938
2128
|
}),
|
|
1939
2129
|
timeSeries: analyticsTimeSeriesSchema
|
|
1940
2130
|
}));
|
|
1941
|
-
const
|
|
2131
|
+
const paginatedInsightsInputShape = {
|
|
2132
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2133
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2134
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2135
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2136
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2137
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2138
|
+
};
|
|
2139
|
+
const listIntentsContractV1 = base.route({
|
|
2140
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2141
|
+
method: "GET",
|
|
2142
|
+
summary: "List intents",
|
|
2143
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2144
|
+
tags: ["insights"],
|
|
2145
|
+
successDescription: "The grouped user intents"
|
|
2146
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2147
|
+
...paginatedInsightsInputShape,
|
|
2148
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2149
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2150
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2151
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2152
|
+
})).output(z.object({
|
|
2153
|
+
intents: z.array(z.object({
|
|
2154
|
+
id: z.string(),
|
|
2155
|
+
intentIds: z.array(z.string()).min(1),
|
|
2156
|
+
environmentId: z.string(),
|
|
2157
|
+
message: z.string(),
|
|
2158
|
+
toolName: z.string(),
|
|
2159
|
+
createdAt: z.coerce.date(),
|
|
2160
|
+
occurrenceCount: z.number().int().positive(),
|
|
2161
|
+
clientName: z.string().nullable(),
|
|
2162
|
+
clientId: z.string().nullable(),
|
|
2163
|
+
categories: z.array(z.object({
|
|
2164
|
+
id: z.string(),
|
|
2165
|
+
name: z.string(),
|
|
2166
|
+
color: intentCategoryColorSchema
|
|
2167
|
+
}))
|
|
2168
|
+
})),
|
|
2169
|
+
totalCount: z.number().int().nonnegative()
|
|
2170
|
+
}));
|
|
2171
|
+
const listFeedbacksContractV1 = base.route({
|
|
2172
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2173
|
+
method: "GET",
|
|
2174
|
+
summary: "List feedbacks",
|
|
2175
|
+
description: "List user feedback for an environment over a time range",
|
|
2176
|
+
tags: ["insights"],
|
|
2177
|
+
successDescription: "The user feedback"
|
|
2178
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2179
|
+
...paginatedInsightsInputShape,
|
|
2180
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2181
|
+
})).output(z.object({
|
|
2182
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2183
|
+
totalCount: z.number().int().nonnegative()
|
|
2184
|
+
}));
|
|
2185
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2186
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2187
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2188
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2189
|
+
method: "GET",
|
|
2190
|
+
summary: "List intent categories",
|
|
2191
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2192
|
+
tags: ["insights"],
|
|
2193
|
+
successDescription: "The intent categories"
|
|
2194
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2195
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2196
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2197
|
+
method: "POST",
|
|
2198
|
+
summary: "Create an intent category",
|
|
2199
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2200
|
+
tags: ["insights"],
|
|
2201
|
+
successDescription: "The created intent category"
|
|
2202
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2203
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2204
|
+
name: intentCategoryNameSchema,
|
|
2205
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2206
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2207
|
+
})).output(intentCategorySchema);
|
|
2208
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2209
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2210
|
+
method: "PATCH",
|
|
2211
|
+
summary: "Update an intent category",
|
|
2212
|
+
description: "Rename or recolor an intent category",
|
|
2213
|
+
tags: ["insights"],
|
|
2214
|
+
successDescription: "The updated intent category"
|
|
2215
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2216
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2217
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2218
|
+
name: intentCategoryNameSchema.optional(),
|
|
2219
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2220
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2221
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2222
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2223
|
+
method: "DELETE",
|
|
2224
|
+
summary: "Delete an intent category",
|
|
2225
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2226
|
+
tags: ["insights"],
|
|
2227
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2228
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2229
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2230
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2231
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2232
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2233
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2234
|
+
method: "POST",
|
|
2235
|
+
summary: "Link an intent category",
|
|
2236
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2237
|
+
tags: ["insights"],
|
|
2238
|
+
successDescription: "The intents have been linked successfully"
|
|
2239
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2240
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2241
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2242
|
+
intentIds: categorizableIntentIdsSchema
|
|
2243
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2244
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2245
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2246
|
+
method: "POST",
|
|
2247
|
+
summary: "Unlink an intent category",
|
|
2248
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2249
|
+
tags: ["insights"],
|
|
2250
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2251
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2252
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2253
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2254
|
+
intentIds: categorizableIntentIdsSchema
|
|
2255
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2256
|
+
const listTeamsContractV1 = base.route({
|
|
1942
2257
|
path: "/v1/teams",
|
|
1943
2258
|
method: "GET",
|
|
1944
2259
|
summary: "List teams",
|
|
@@ -1951,7 +2266,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1951
2266
|
createdAt: z.coerce.date(),
|
|
1952
2267
|
hasStripeAccount: z.boolean()
|
|
1953
2268
|
})));
|
|
1954
|
-
const
|
|
2269
|
+
const getTeamUsageContractV1 = base.route({
|
|
2270
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2271
|
+
method: "GET",
|
|
2272
|
+
summary: "Get team usage",
|
|
2273
|
+
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.",
|
|
2274
|
+
tags: ["teams"],
|
|
2275
|
+
successDescription: "The current billing window usage"
|
|
2276
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2277
|
+
teamId: z.string(),
|
|
2278
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2279
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2280
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2281
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2282
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2283
|
+
}));
|
|
2284
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1955
2285
|
path: "/v1/tunnels/ticket",
|
|
1956
2286
|
method: "GET",
|
|
1957
2287
|
summary: "Get a tunnel ticket",
|
|
@@ -1963,16 +2293,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1963
2293
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1964
2294
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1965
2295
|
}));
|
|
1966
|
-
const publishServerContractV1 =
|
|
2296
|
+
const publishServerContractV1 = base.route({
|
|
1967
2297
|
path: "/v1/distribution/publish",
|
|
1968
2298
|
method: "POST",
|
|
1969
2299
|
summary: "Publish a server to the MCP registry",
|
|
1970
2300
|
tags: ["distribution"],
|
|
1971
2301
|
successDescription: "The server has been published successfully"
|
|
1972
|
-
}).errors({
|
|
1973
|
-
NOT_FOUND: {},
|
|
1974
|
-
BAD_REQUEST: {}
|
|
1975
|
-
}).input(z.object({
|
|
2302
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1976
2303
|
projectId: z.string(),
|
|
1977
2304
|
domain: z.string(),
|
|
1978
2305
|
title: z.string().min(1).max(100),
|
|
@@ -1981,17 +2308,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1981
2308
|
iconSrc: z.url().max(255).optional(),
|
|
1982
2309
|
dryRun: z.boolean().optional()
|
|
1983
2310
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1984
|
-
const getServerInfoContractV1 =
|
|
2311
|
+
const getServerInfoContractV1 = base.route({
|
|
1985
2312
|
path: "/v1/distribution/get",
|
|
1986
2313
|
method: "GET",
|
|
1987
2314
|
summary: "Get server info",
|
|
1988
2315
|
description: "Get info about a server",
|
|
1989
2316
|
tags: ["distribution"],
|
|
1990
2317
|
successDescription: "The server info"
|
|
1991
|
-
}).errors({
|
|
1992
|
-
NOT_FOUND: {},
|
|
1993
|
-
BAD_REQUEST: {}
|
|
1994
|
-
}).input(z.object({
|
|
2318
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1995
2319
|
projectId: z.string(),
|
|
1996
2320
|
domain: z.string()
|
|
1997
2321
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -2010,7 +2334,7 @@ const playgroundOutputSchema = z.object({
|
|
|
2010
2334
|
isPlaygroundEnabled: z.boolean(),
|
|
2011
2335
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
2012
2336
|
});
|
|
2013
|
-
const getPlaygroundContractV1 =
|
|
2337
|
+
const getPlaygroundContractV1 = base.route({
|
|
2014
2338
|
path: "/v1/environments/{environmentId}/playground",
|
|
2015
2339
|
method: "GET",
|
|
2016
2340
|
summary: "Get playground configuration",
|
|
@@ -2018,17 +2342,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
2018
2342
|
tags: ["environments"],
|
|
2019
2343
|
successDescription: "The playground configuration"
|
|
2020
2344
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
2021
|
-
const upsertPlaygroundContractV1 =
|
|
2345
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
2022
2346
|
path: "/v1/environments/{environmentId}/playground",
|
|
2023
2347
|
method: "PUT",
|
|
2024
2348
|
summary: "Update playground configuration",
|
|
2025
2349
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
2026
2350
|
tags: ["environments"],
|
|
2027
2351
|
successDescription: "The updated playground configuration"
|
|
2028
|
-
}).errors({
|
|
2029
|
-
NOT_FOUND: {},
|
|
2030
|
-
BAD_REQUEST: {}
|
|
2031
|
-
}).input(z.object({
|
|
2352
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2032
2353
|
environmentId: z.string().describe("The ID of the environment"),
|
|
2033
2354
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
2034
2355
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -2036,7 +2357,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
2036
2357
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
2037
2358
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
2038
2359
|
})).output(playgroundOutputSchema);
|
|
2039
|
-
const createBeaconContractV1 =
|
|
2360
|
+
const createBeaconContractV1 = base.route({
|
|
2040
2361
|
path: "/v1/beacon/audits",
|
|
2041
2362
|
method: "POST",
|
|
2042
2363
|
summary: "Create a beacon audit",
|
|
@@ -2045,7 +2366,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
2045
2366
|
successDescription: "The audit has been created"
|
|
2046
2367
|
}).errors({
|
|
2047
2368
|
NOT_FOUND: {},
|
|
2048
|
-
BAD_REQUEST: {},
|
|
2049
2369
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
2050
2370
|
}).input(z.object({
|
|
2051
2371
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -2053,7 +2373,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
2053
2373
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
2054
2374
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
2055
2375
|
})).output(z.object({ id: z.string() }));
|
|
2056
|
-
const getBeaconContractV1 =
|
|
2376
|
+
const getBeaconContractV1 = base.route({
|
|
2057
2377
|
path: "/v1/beacon/audits/{auditId}",
|
|
2058
2378
|
method: "GET",
|
|
2059
2379
|
summary: "Get a beacon audit",
|
|
@@ -2068,9 +2388,73 @@ const getBeaconContractV1 = oc.route({
|
|
|
2068
2388
|
createdAt: z.coerce.date(),
|
|
2069
2389
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
2070
2390
|
}));
|
|
2391
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2392
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2393
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2394
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2395
|
+
const createSubmissionContractV1 = base.route({
|
|
2396
|
+
path: "/v1/submissions",
|
|
2397
|
+
method: "POST",
|
|
2398
|
+
summary: "Create a submission package",
|
|
2399
|
+
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.",
|
|
2400
|
+
tags: ["submissions"],
|
|
2401
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2402
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2403
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2404
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2405
|
+
})).output(submissionSchema);
|
|
2406
|
+
const listSubmissionsContractV1 = base.route({
|
|
2407
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2408
|
+
method: "GET",
|
|
2409
|
+
summary: "List submission packages",
|
|
2410
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2411
|
+
tags: ["submissions"],
|
|
2412
|
+
successDescription: "The list of submission packages"
|
|
2413
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2414
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2415
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2416
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2417
|
+
})).output(z.array(submissionSchema));
|
|
2418
|
+
const getSubmissionContractV1 = base.route({
|
|
2419
|
+
path: "/v1/submissions/{submissionId}",
|
|
2420
|
+
method: "GET",
|
|
2421
|
+
summary: "Get a submission package",
|
|
2422
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2423
|
+
tags: ["submissions"],
|
|
2424
|
+
successDescription: "The submission package"
|
|
2425
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2426
|
+
const updateSubmissionContractV1 = base.route({
|
|
2427
|
+
path: "/v1/submissions/{submissionId}",
|
|
2428
|
+
method: "PUT",
|
|
2429
|
+
summary: "Update a submission package",
|
|
2430
|
+
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.",
|
|
2431
|
+
tags: ["submissions"],
|
|
2432
|
+
successDescription: "The updated submission package"
|
|
2433
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2434
|
+
submissionId: submissionIdSchema,
|
|
2435
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2436
|
+
formData: claudeSubmissionUpdateSchema
|
|
2437
|
+
}), z.object({
|
|
2438
|
+
submissionId: submissionIdSchema,
|
|
2439
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2440
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2441
|
+
})])).output(submissionSchema);
|
|
2071
2442
|
const contract = {
|
|
2072
|
-
teams: {
|
|
2443
|
+
teams: {
|
|
2444
|
+
list: { v1: listTeamsContractV1 },
|
|
2445
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2446
|
+
},
|
|
2073
2447
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2448
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2449
|
+
intentCategories: {
|
|
2450
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2451
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2452
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2453
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2454
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2455
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2456
|
+
},
|
|
2457
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
2074
2458
|
deployments: {
|
|
2075
2459
|
list: { v1: listDeploymentsContractV1 },
|
|
2076
2460
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -2080,6 +2464,7 @@ const contract = {
|
|
|
2080
2464
|
environments: {
|
|
2081
2465
|
create: { v1: createEnvironmentContractV1 },
|
|
2082
2466
|
get: { v1: getEnvironmentContractV1 },
|
|
2467
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
2083
2468
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
2084
2469
|
getLogs: { v1: getLogsContractV1 },
|
|
2085
2470
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -2109,6 +2494,12 @@ const contract = {
|
|
|
2109
2494
|
beacon: {
|
|
2110
2495
|
create: { v1: createBeaconContractV1 },
|
|
2111
2496
|
get: { v1: getBeaconContractV1 }
|
|
2497
|
+
},
|
|
2498
|
+
submissions: {
|
|
2499
|
+
create: { v1: createSubmissionContractV1 },
|
|
2500
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2501
|
+
get: { v1: getSubmissionContractV1 },
|
|
2502
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2112
2503
|
}
|
|
2113
2504
|
};
|
|
2114
2505
|
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
@@ -2116,5 +2507,26 @@ const contractForDocs = {
|
|
|
2116
2507
|
...contract,
|
|
2117
2508
|
deployments: deploymentsForDocs
|
|
2118
2509
|
};
|
|
2510
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2511
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2512
|
+
info: {
|
|
2513
|
+
title: "Alpic API",
|
|
2514
|
+
version: "1.0.0"
|
|
2515
|
+
},
|
|
2516
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2517
|
+
security: [{ bearerAuth: [] }],
|
|
2518
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2519
|
+
type: "http",
|
|
2520
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2521
|
+
scheme: "bearer"
|
|
2522
|
+
} } },
|
|
2523
|
+
commonSchemas: {
|
|
2524
|
+
Submission: { schema: submissionSchema },
|
|
2525
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2526
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2527
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2528
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
2529
|
+
}
|
|
2530
|
+
};
|
|
2119
2531
|
//#endregion
|
|
2120
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2532
|
+
export { AI_PLATFORMS, AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, OPENAPI_DOC_OPTIONS, PLATFORM_LABELS, buildSettingsSchema, chatgptSubmissionUpdateSchema, claudeSubmissionUpdateSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|