@alpic-ai/api 0.0.0-dev.gf4be546 → 0.0.0-dev.gf50a6a5
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 +5384 -124
- package/dist/index.mjs +488 -111
- 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.30.0_supports-color@7.2.0_zod@4.4
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.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
|
*/
|
|
@@ -179,6 +179,7 @@ const PLATFORM_LABELS = {
|
|
|
179
179
|
};
|
|
180
180
|
const WAF_PLATFORMS = [
|
|
181
181
|
"akamai",
|
|
182
|
+
"cato",
|
|
182
183
|
"cloudflare",
|
|
183
184
|
"fastly"
|
|
184
185
|
];
|
|
@@ -256,6 +257,25 @@ z.object({
|
|
|
256
257
|
clientSecret: z.string(),
|
|
257
258
|
clientScopes: z.array(z.string())
|
|
258
259
|
});
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"admin_adjustment"
|
|
266
|
+
]);
|
|
267
|
+
z.enum(["playground"]);
|
|
268
|
+
z.number().int().min(500);
|
|
269
|
+
const creditActivityEntrySchema = z.object({
|
|
270
|
+
reason: creditEntryReasonSchema,
|
|
271
|
+
day: z.number(),
|
|
272
|
+
amountInNanoUSD: z.number(),
|
|
273
|
+
messageCount: z.number().nullable()
|
|
274
|
+
});
|
|
275
|
+
z.object({
|
|
276
|
+
balanceInNanoUSD: z.number(),
|
|
277
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
278
|
+
});
|
|
259
279
|
const deploymentStatusSchema$1 = z.enum([
|
|
260
280
|
"ongoing",
|
|
261
281
|
"deployed",
|
|
@@ -402,7 +422,7 @@ z.object({
|
|
|
402
422
|
collectUserData: z.boolean(),
|
|
403
423
|
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
404
424
|
});
|
|
405
|
-
z.object({
|
|
425
|
+
const feedbackSchema = z.object({
|
|
406
426
|
id: z.string(),
|
|
407
427
|
createdAt: z.coerce.date(),
|
|
408
428
|
environmentId: z.string(),
|
|
@@ -424,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
424
444
|
"pink",
|
|
425
445
|
"gray"
|
|
426
446
|
]);
|
|
427
|
-
intentCategoryColorSchema.options;
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
428
448
|
const intentCategorySchema = z.object({
|
|
429
449
|
id: z.string(),
|
|
430
450
|
createdAt: z.coerce.date(),
|
|
@@ -432,7 +452,7 @@ const intentCategorySchema = z.object({
|
|
|
432
452
|
name: z.string(),
|
|
433
453
|
color: intentCategoryColorSchema
|
|
434
454
|
});
|
|
435
|
-
z.object({
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
436
456
|
id: z.string(),
|
|
437
457
|
name: z.string(),
|
|
438
458
|
color: intentCategoryColorSchema,
|
|
@@ -503,6 +523,16 @@ z.object({
|
|
|
503
523
|
createdAt: z.coerce.date(),
|
|
504
524
|
updatedAt: z.coerce.date()
|
|
505
525
|
});
|
|
526
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
527
|
+
type: z.literal("mcp_request"),
|
|
528
|
+
method: z.string()
|
|
529
|
+
});
|
|
530
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
531
|
+
type: z.literal("mcp_error"),
|
|
532
|
+
method: z.string(),
|
|
533
|
+
error: z.string()
|
|
534
|
+
});
|
|
535
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
506
536
|
z.enum([
|
|
507
537
|
"INFO",
|
|
508
538
|
"WARNING",
|
|
@@ -834,6 +864,10 @@ const clampStringField = (field) => {
|
|
|
834
864
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
835
865
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
836
866
|
};
|
|
867
|
+
const unboundedArrayField = (field) => {
|
|
868
|
+
const unbounded = z.array(field.element);
|
|
869
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
870
|
+
};
|
|
837
871
|
const toolDefinitionSchema = z.object({
|
|
838
872
|
name: z.string(),
|
|
839
873
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -846,11 +880,22 @@ const toolDefinitionSchema = z.object({
|
|
|
846
880
|
}).optional()
|
|
847
881
|
});
|
|
848
882
|
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."),
|
|
883
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
884
|
+
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
885
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
852
886
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
853
|
-
}).
|
|
887
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
888
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
889
|
+
scenario: z.string().optional(),
|
|
890
|
+
userPrompt: z.string().optional()
|
|
891
|
+
});
|
|
892
|
+
const blankPositiveTestCase = () => ({
|
|
893
|
+
scenario: "",
|
|
894
|
+
userPrompt: "",
|
|
895
|
+
toolTriggered: "",
|
|
896
|
+
expectedOutput: ""
|
|
897
|
+
});
|
|
898
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
854
899
|
const screenshotEntrySchema = z.object({
|
|
855
900
|
prompt: z.string(),
|
|
856
901
|
url: z.url()
|
|
@@ -1163,9 +1208,18 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
1163
1208
|
"zh-TW"
|
|
1164
1209
|
]);
|
|
1165
1210
|
const negativeTestCaseSchema = z.object({
|
|
1166
|
-
scenario: z.string(),
|
|
1167
|
-
userPrompt: z.string()
|
|
1168
|
-
}).
|
|
1211
|
+
scenario: z.string().min(1),
|
|
1212
|
+
userPrompt: z.string().min(1)
|
|
1213
|
+
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1214
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1215
|
+
scenario: z.string().optional(),
|
|
1216
|
+
userPrompt: z.string().optional()
|
|
1217
|
+
});
|
|
1218
|
+
const blankNegativeTestCase = () => ({
|
|
1219
|
+
scenario: "",
|
|
1220
|
+
userPrompt: ""
|
|
1221
|
+
});
|
|
1222
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
1169
1223
|
const chatgptToolJustificationSchema = z.object({
|
|
1170
1224
|
toolName: z.string(),
|
|
1171
1225
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
@@ -1200,8 +1254,9 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
1200
1254
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
1201
1255
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1202
1256
|
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
|
-
|
|
1257
|
+
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."),
|
|
1258
|
+
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."),
|
|
1259
|
+
negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 3 negative test cases: prompts where the app 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 app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
1205
1260
|
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
1206
1261
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1207
1262
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
@@ -1216,23 +1271,35 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
1216
1271
|
demoRecordingUrl: z.string().optional(),
|
|
1217
1272
|
serverUrl: z.string().optional(),
|
|
1218
1273
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1274
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1275
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1219
1276
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1220
1277
|
});
|
|
1221
|
-
|
|
1278
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1279
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1222
1280
|
appName: true,
|
|
1223
1281
|
developerName: true,
|
|
1224
1282
|
serverUrl: true,
|
|
1225
1283
|
tools: true,
|
|
1284
|
+
skills: true,
|
|
1226
1285
|
authentication: true
|
|
1227
1286
|
});
|
|
1228
|
-
|
|
1287
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1288
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1229
1289
|
tagline: true,
|
|
1230
1290
|
description: true,
|
|
1231
1291
|
category: true,
|
|
1232
1292
|
testCases: true,
|
|
1233
1293
|
negativeTestCases: true,
|
|
1234
1294
|
toolJustifications: true
|
|
1235
|
-
}).extend({
|
|
1295
|
+
}).extend({
|
|
1296
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1297
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1298
|
+
}).extend({
|
|
1299
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1300
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1301
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1302
|
+
});
|
|
1236
1303
|
const claudeCategorySchema = z.enum([
|
|
1237
1304
|
"Productivity",
|
|
1238
1305
|
"Communication",
|
|
@@ -1355,7 +1422,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1355
1422
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1356
1423
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1357
1424
|
});
|
|
1358
|
-
|
|
1425
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1426
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1359
1427
|
serverUrl: true,
|
|
1360
1428
|
name: true,
|
|
1361
1429
|
slug: true,
|
|
@@ -1377,27 +1445,86 @@ const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
|
1377
1445
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1378
1446
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1379
1447
|
});
|
|
1380
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1448
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1381
1449
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1382
1450
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1383
1451
|
});
|
|
1452
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1453
|
+
const byField = {};
|
|
1454
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1455
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1456
|
+
return byField;
|
|
1457
|
+
}
|
|
1458
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1459
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1460
|
+
"pass",
|
|
1461
|
+
"fail",
|
|
1462
|
+
"unverified"
|
|
1463
|
+
]);
|
|
1464
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1465
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1466
|
+
claudeai: ["privacyPolicy"]
|
|
1467
|
+
};
|
|
1468
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1469
|
+
const policyDisclosureSchema = z.enum([
|
|
1470
|
+
"dataCategories",
|
|
1471
|
+
"purposesOfUse",
|
|
1472
|
+
"recipients",
|
|
1473
|
+
"retention"
|
|
1474
|
+
]);
|
|
1475
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1476
|
+
field: verifiableUrlFieldSchema,
|
|
1477
|
+
url: z.string(),
|
|
1478
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1479
|
+
reason: z.string(),
|
|
1480
|
+
concerns: z.array(z.string()).optional(),
|
|
1481
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1482
|
+
});
|
|
1483
|
+
const urlVerificationSchema = z.object({
|
|
1484
|
+
verifiedAt: z.coerce.date(),
|
|
1485
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1486
|
+
});
|
|
1487
|
+
const pageKindSchema = z.enum([
|
|
1488
|
+
"expectedDocument",
|
|
1489
|
+
"errorPage",
|
|
1490
|
+
"loginWall",
|
|
1491
|
+
"parkedDomain",
|
|
1492
|
+
"comingSoon",
|
|
1493
|
+
"marketingPage",
|
|
1494
|
+
"unrelatedDocument"
|
|
1495
|
+
]);
|
|
1496
|
+
z.object({
|
|
1497
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1498
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1499
|
+
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.")
|
|
1500
|
+
});
|
|
1384
1501
|
const submissionMetaFieldsSchema = z.object({
|
|
1385
1502
|
id: z.string(),
|
|
1386
1503
|
environmentId: z.string(),
|
|
1387
1504
|
auditId: z.string().nullable(),
|
|
1505
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1388
1506
|
createdAt: z.coerce.date(),
|
|
1389
1507
|
updatedAt: z.coerce.date()
|
|
1390
1508
|
});
|
|
1391
1509
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1392
1510
|
platform: z.literal("claudeai"),
|
|
1393
|
-
formData: claudeSubmissionDraftSchema
|
|
1511
|
+
formData: claudeSubmissionDraftSchema,
|
|
1512
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1394
1513
|
});
|
|
1395
1514
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1396
1515
|
platform: z.literal("chatgpt"),
|
|
1397
|
-
formData: chatgptSubmissionDraftSchema
|
|
1516
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1517
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1398
1518
|
});
|
|
1399
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1519
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1400
1520
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1521
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1522
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1523
|
+
z.literal([
|
|
1524
|
+
100,
|
|
1525
|
+
75,
|
|
1526
|
+
50
|
|
1527
|
+
]);
|
|
1401
1528
|
const subscriptionPlanSchema = z.enum([
|
|
1402
1529
|
"pro",
|
|
1403
1530
|
"business",
|
|
@@ -1409,17 +1536,70 @@ const customerCreditsSchema = z.object({
|
|
|
1409
1536
|
expiresAt: z.number().nullable(),
|
|
1410
1537
|
currency: z.string()
|
|
1411
1538
|
});
|
|
1412
|
-
const customerUsageSchema = z.object({
|
|
1413
|
-
amountInCents: z.number(),
|
|
1414
|
-
currency: z.string(),
|
|
1415
|
-
periodEnd: z.number()
|
|
1416
|
-
});
|
|
1417
1539
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1418
1540
|
z.object({
|
|
1419
1541
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1420
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1421
1542
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1422
1543
|
});
|
|
1544
|
+
const metricsQueueEventSchema = z.object({
|
|
1545
|
+
ts: z.number().int(),
|
|
1546
|
+
method: z.string(),
|
|
1547
|
+
tool: z.string().nullable(),
|
|
1548
|
+
client: z.string(),
|
|
1549
|
+
sessionId: z.string().nullable(),
|
|
1550
|
+
durationMs: z.number().int(),
|
|
1551
|
+
outputTokens: z.number().int().nullable(),
|
|
1552
|
+
errorType: z.enum([
|
|
1553
|
+
"mcp_error",
|
|
1554
|
+
"tool_error",
|
|
1555
|
+
"timeout"
|
|
1556
|
+
]).nullable(),
|
|
1557
|
+
errorCode: z.number().int().nullable()
|
|
1558
|
+
});
|
|
1559
|
+
z.object({
|
|
1560
|
+
v: z.literal(1),
|
|
1561
|
+
envId: z.string(),
|
|
1562
|
+
events: z.array(metricsQueueEventSchema)
|
|
1563
|
+
});
|
|
1564
|
+
z.object({ v: z.number() });
|
|
1565
|
+
const telemetrySignalSchema = z.enum([
|
|
1566
|
+
"logs",
|
|
1567
|
+
"metrics",
|
|
1568
|
+
"traces"
|
|
1569
|
+
]);
|
|
1570
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1571
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1572
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1573
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1574
|
+
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");
|
|
1575
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1576
|
+
id: z.string(),
|
|
1577
|
+
name: otlpHeaderNameSchema,
|
|
1578
|
+
value: otlpHeaderValueSchema,
|
|
1579
|
+
isSecret: z.boolean()
|
|
1580
|
+
});
|
|
1581
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1582
|
+
"credentials",
|
|
1583
|
+
"wrong-path",
|
|
1584
|
+
"wrong-protocol",
|
|
1585
|
+
"invalid-payload",
|
|
1586
|
+
"partial-rejection",
|
|
1587
|
+
"blocked-target",
|
|
1588
|
+
"timeout",
|
|
1589
|
+
"unreachable",
|
|
1590
|
+
"receiver-error",
|
|
1591
|
+
"unexpected-status"
|
|
1592
|
+
]);
|
|
1593
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1594
|
+
z.object({
|
|
1595
|
+
id: z.string(),
|
|
1596
|
+
signal: telemetrySignalSchema,
|
|
1597
|
+
endpoint: otlpEndpointSchema,
|
|
1598
|
+
protocol: otlpProtocolSchema,
|
|
1599
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1600
|
+
status: telemetryDestinationStatusSchema,
|
|
1601
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1602
|
+
});
|
|
1423
1603
|
//#endregion
|
|
1424
1604
|
//#region src/auth-scope.ts
|
|
1425
1605
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1518,6 +1698,14 @@ const serverFieldsSchema = z.object({
|
|
|
1518
1698
|
});
|
|
1519
1699
|
//#endregion
|
|
1520
1700
|
//#region src/api.contract.ts
|
|
1701
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1702
|
+
try {
|
|
1703
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1704
|
+
return true;
|
|
1705
|
+
} catch {
|
|
1706
|
+
return false;
|
|
1707
|
+
}
|
|
1708
|
+
};
|
|
1521
1709
|
const deploymentStatusSchema = z.enum([
|
|
1522
1710
|
"ongoing",
|
|
1523
1711
|
"deployed",
|
|
@@ -1546,21 +1734,20 @@ const deploymentSchema = z.object({
|
|
|
1546
1734
|
isCurrent: z.boolean(),
|
|
1547
1735
|
deploymentPageUrl: z.url().nullable()
|
|
1548
1736
|
});
|
|
1549
|
-
const
|
|
1737
|
+
const isValidTimeInput = (value) => {
|
|
1550
1738
|
if (ms(value) !== void 0) return true;
|
|
1551
1739
|
return !Number.isNaN(new Date(value).getTime());
|
|
1552
1740
|
};
|
|
1553
|
-
const
|
|
1741
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1742
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1743
|
+
const createEnvironmentContractV1 = base.route({
|
|
1554
1744
|
path: "/v1/environments",
|
|
1555
1745
|
method: "POST",
|
|
1556
1746
|
summary: "Create an environment",
|
|
1557
1747
|
description: "Create an environment for a project",
|
|
1558
1748
|
tags: ["environments"],
|
|
1559
1749
|
successDescription: "The environment has been created successfully"
|
|
1560
|
-
}).errors({
|
|
1561
|
-
NOT_FOUND: {},
|
|
1562
|
-
BAD_REQUEST: {}
|
|
1563
|
-
}).input(z.object({
|
|
1750
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1564
1751
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1565
1752
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1566
1753
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1573,7 +1760,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1573
1760
|
createdAt: z.coerce.date(),
|
|
1574
1761
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1575
1762
|
}));
|
|
1576
|
-
const getEnvironmentContractV1 =
|
|
1763
|
+
const getEnvironmentContractV1 = base.route({
|
|
1577
1764
|
path: "/v1/environments/{environmentId}",
|
|
1578
1765
|
method: "GET",
|
|
1579
1766
|
summary: "Get an environment",
|
|
@@ -1589,6 +1776,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1589
1776
|
createdAt: z.coerce.date(),
|
|
1590
1777
|
projectId: z.string()
|
|
1591
1778
|
}));
|
|
1779
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1780
|
+
path: "/v1/environments/{environmentId}",
|
|
1781
|
+
method: "DELETE",
|
|
1782
|
+
summary: "Delete an environment",
|
|
1783
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1784
|
+
tags: ["environments"],
|
|
1785
|
+
successDescription: "The environment has been deleted successfully"
|
|
1786
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1592
1787
|
const domainSchema = z.object({
|
|
1593
1788
|
domain: z.string(),
|
|
1594
1789
|
status: z.enum([
|
|
@@ -1630,7 +1825,7 @@ const projectOutputSchema = z.object({
|
|
|
1630
1825
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1631
1826
|
environments: z.array(environmentSchema)
|
|
1632
1827
|
});
|
|
1633
|
-
const getProjectContractV1 =
|
|
1828
|
+
const getProjectContractV1 = base.route({
|
|
1634
1829
|
path: "/v1/projects/{projectId}",
|
|
1635
1830
|
method: "GET",
|
|
1636
1831
|
summary: "Get a project",
|
|
@@ -1638,18 +1833,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1638
1833
|
tags: ["projects"],
|
|
1639
1834
|
successDescription: "The project details"
|
|
1640
1835
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1641
|
-
const listProjectsContractV1 =
|
|
1836
|
+
const listProjectsContractV1 = base.route({
|
|
1642
1837
|
path: "/v1/projects",
|
|
1643
1838
|
method: "GET",
|
|
1644
1839
|
summary: "List projects",
|
|
1645
1840
|
description: "List all projects for a team",
|
|
1646
1841
|
tags: ["projects"],
|
|
1647
1842
|
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({
|
|
1843
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1844
|
+
const createProjectContractV1 = base.route({
|
|
1653
1845
|
path: "/v1/projects",
|
|
1654
1846
|
method: "POST",
|
|
1655
1847
|
summary: "Create a project",
|
|
@@ -1658,7 +1850,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1658
1850
|
successDescription: "The project has been created successfully"
|
|
1659
1851
|
}).errors({
|
|
1660
1852
|
NOT_FOUND: {},
|
|
1661
|
-
BAD_REQUEST: {},
|
|
1662
1853
|
FORBIDDEN: {}
|
|
1663
1854
|
}).input(z.object({
|
|
1664
1855
|
teamId: z.string().optional(),
|
|
@@ -1699,7 +1890,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1699
1890
|
isSecret: z.boolean(),
|
|
1700
1891
|
createdAt: z.coerce.date()
|
|
1701
1892
|
});
|
|
1702
|
-
const listEnvironmentVariablesContractV1 =
|
|
1893
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1703
1894
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1704
1895
|
method: "GET",
|
|
1705
1896
|
summary: "List environment variables",
|
|
@@ -1707,48 +1898,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1707
1898
|
tags: ["environments"],
|
|
1708
1899
|
successDescription: "The list of environment variables"
|
|
1709
1900
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1710
|
-
const createEnvironmentVariablesContractV1 =
|
|
1901
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1711
1902
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1712
1903
|
method: "POST",
|
|
1713
1904
|
summary: "Add environment variables",
|
|
1714
1905
|
description: "Add one or more environment variables to an environment",
|
|
1715
1906
|
tags: ["environments"],
|
|
1716
1907
|
successDescription: "The environment variables have been added successfully"
|
|
1717
|
-
}).errors({
|
|
1718
|
-
NOT_FOUND: {},
|
|
1719
|
-
BAD_REQUEST: {}
|
|
1720
|
-
}).input(z.object({
|
|
1908
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1721
1909
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1722
1910
|
environmentVariables: environmentVariablesSchema
|
|
1723
1911
|
})).output(z.object({ success: z.literal(true) }));
|
|
1724
|
-
const updateEnvironmentVariableContractV1 =
|
|
1912
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1725
1913
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1726
1914
|
method: "PATCH",
|
|
1727
1915
|
summary: "Update an environment variable",
|
|
1728
1916
|
description: "Update an environment variable by ID",
|
|
1729
1917
|
tags: ["environments"],
|
|
1730
1918
|
successDescription: "The environment variable has been updated successfully"
|
|
1731
|
-
}).errors({
|
|
1732
|
-
NOT_FOUND: {},
|
|
1733
|
-
BAD_REQUEST: {}
|
|
1734
|
-
}).input(z.object({
|
|
1919
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1735
1920
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1736
1921
|
key: environmentVariableSchema.shape.key,
|
|
1737
1922
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1738
1923
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1739
1924
|
})).output(z.object({ success: z.literal(true) }));
|
|
1740
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1925
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1741
1926
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1742
1927
|
method: "DELETE",
|
|
1743
1928
|
summary: "Delete an environment variable",
|
|
1744
1929
|
description: "Delete an environment variable by ID",
|
|
1745
1930
|
tags: ["environments"],
|
|
1746
1931
|
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({
|
|
1932
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1933
|
+
const deleteProjectContractV1 = base.route({
|
|
1752
1934
|
path: "/v1/projects/{projectId}",
|
|
1753
1935
|
method: "DELETE",
|
|
1754
1936
|
summary: "Delete a project",
|
|
@@ -1756,7 +1938,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1756
1938
|
tags: ["projects"],
|
|
1757
1939
|
successDescription: "The project has been deleted successfully"
|
|
1758
1940
|
}).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 =
|
|
1941
|
+
const updateProjectContractV1 = base.route({
|
|
1760
1942
|
path: "/v1/projects/{projectId}",
|
|
1761
1943
|
method: "PATCH",
|
|
1762
1944
|
summary: "Update a project",
|
|
@@ -1765,14 +1947,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1765
1947
|
successDescription: "The project has been updated successfully"
|
|
1766
1948
|
}).errors({
|
|
1767
1949
|
NOT_FOUND: {},
|
|
1768
|
-
BAD_REQUEST: {},
|
|
1769
1950
|
FORBIDDEN: {}
|
|
1770
1951
|
}).input(z.object({
|
|
1771
1952
|
projectId: z.string().describe("The ID of the project"),
|
|
1772
1953
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1773
1954
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1774
1955
|
})).output(projectOutputSchema);
|
|
1775
|
-
const deployEnvironmentContractV1 =
|
|
1956
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1776
1957
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1777
1958
|
method: "POST",
|
|
1778
1959
|
summary: "Deploy an environment",
|
|
@@ -1781,29 +1962,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1781
1962
|
successDescription: "The environment has been deployed successfully"
|
|
1782
1963
|
}).errors({
|
|
1783
1964
|
NOT_FOUND: {},
|
|
1784
|
-
BAD_REQUEST: {},
|
|
1785
1965
|
CONFLICT: {}
|
|
1786
1966
|
}).input(z.object({
|
|
1787
1967
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1788
1968
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1789
1969
|
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
1970
|
})).output(deploymentSchema);
|
|
1791
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1971
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1792
1972
|
path: "/v1/deployments/upload",
|
|
1793
1973
|
method: "POST",
|
|
1794
1974
|
summary: "Upload deployment artifacts",
|
|
1795
1975
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1796
1976
|
tags: ["deployments"],
|
|
1797
1977
|
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({
|
|
1978
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1802
1979
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1803
1980
|
token: z.string().describe("Token to identify the source archive"),
|
|
1804
1981
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1805
1982
|
}));
|
|
1806
|
-
const listDeploymentsContractV1 =
|
|
1983
|
+
const listDeploymentsContractV1 = base.route({
|
|
1807
1984
|
path: "/v1/projects/{projectId}/deployments",
|
|
1808
1985
|
method: "GET",
|
|
1809
1986
|
summary: "List project deployments",
|
|
@@ -1815,7 +1992,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1815
1992
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1816
1993
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1817
1994
|
})).output(z.array(deploymentSchema));
|
|
1818
|
-
const getDeploymentContractV1 =
|
|
1995
|
+
const getDeploymentContractV1 = base.route({
|
|
1819
1996
|
path: "/v1/deployments/{deploymentId}",
|
|
1820
1997
|
method: "GET",
|
|
1821
1998
|
summary: "Get a deployment",
|
|
@@ -1838,20 +2015,17 @@ const logEntrySchema = z.object({
|
|
|
1838
2015
|
method: z.string().optional(),
|
|
1839
2016
|
durationInMs: z.number().optional()
|
|
1840
2017
|
});
|
|
1841
|
-
const getLogsContractV1 =
|
|
2018
|
+
const getLogsContractV1 = base.route({
|
|
1842
2019
|
path: "/v1/environments/{environmentId}/logs",
|
|
1843
2020
|
method: "GET",
|
|
1844
2021
|
summary: "Get logs",
|
|
1845
2022
|
description: "Get logs for an environment",
|
|
1846
2023
|
tags: ["environments"],
|
|
1847
2024
|
successDescription: "The logs"
|
|
1848
|
-
}).errors({
|
|
1849
|
-
NOT_FOUND: {},
|
|
1850
|
-
BAD_REQUEST: {}
|
|
1851
|
-
}).input(z.object({
|
|
2025
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1852
2026
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1853
|
-
since:
|
|
1854
|
-
until:
|
|
2027
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2028
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1855
2029
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1856
2030
|
level: z.array(z.enum([
|
|
1857
2031
|
"INFO",
|
|
@@ -1865,17 +2039,14 @@ const getLogsContractV1 = oc.route({
|
|
|
1865
2039
|
logs: z.array(logEntrySchema),
|
|
1866
2040
|
nextToken: z.string().nullable()
|
|
1867
2041
|
}));
|
|
1868
|
-
const getLatestLogsContractV1 =
|
|
2042
|
+
const getLatestLogsContractV1 = base.route({
|
|
1869
2043
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1870
2044
|
method: "GET",
|
|
1871
2045
|
summary: "Get latest logs",
|
|
1872
2046
|
description: "Get the N most recent logs for an environment",
|
|
1873
2047
|
tags: ["environments"],
|
|
1874
2048
|
successDescription: "The latest logs"
|
|
1875
|
-
}).errors({
|
|
1876
|
-
NOT_FOUND: {},
|
|
1877
|
-
BAD_REQUEST: {}
|
|
1878
|
-
}).input(z.object({
|
|
2049
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1879
2050
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1880
2051
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1881
2052
|
level: z.array(z.enum([
|
|
@@ -1886,7 +2057,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1886
2057
|
])).optional().describe("Filter by log level"),
|
|
1887
2058
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1888
2059
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1889
|
-
const getDeploymentLogsContractV1 =
|
|
2060
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1890
2061
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1891
2062
|
method: "GET",
|
|
1892
2063
|
summary: "Get deployment logs",
|
|
@@ -1913,22 +2084,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1913
2084
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1914
2085
|
task_count: z.array(analyticsDataPointSchema)
|
|
1915
2086
|
});
|
|
1916
|
-
const getProjectAnalyticsContractV1 =
|
|
2087
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1917
2088
|
path: "/v1/analytics/{projectId}",
|
|
1918
2089
|
method: "GET",
|
|
1919
2090
|
summary: "Get project analytics",
|
|
1920
2091
|
description: "Get analytics data for a project over a time range",
|
|
1921
2092
|
tags: ["analytics"],
|
|
1922
2093
|
successDescription: "The project analytics data"
|
|
1923
|
-
}).errors({
|
|
1924
|
-
NOT_FOUND: {},
|
|
1925
|
-
BAD_REQUEST: {}
|
|
1926
|
-
}).input(z.object({
|
|
2094
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1927
2095
|
projectId: z.string().describe("The ID of the project"),
|
|
1928
2096
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1929
2097
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1930
2098
|
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 <=
|
|
2099
|
+
}).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
2100
|
metadata: z.object({
|
|
1933
2101
|
startTimestamp: z.number(),
|
|
1934
2102
|
endTimestamp: z.number(),
|
|
@@ -1938,7 +2106,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1938
2106
|
}),
|
|
1939
2107
|
timeSeries: analyticsTimeSeriesSchema
|
|
1940
2108
|
}));
|
|
1941
|
-
const
|
|
2109
|
+
const paginatedInsightsInputShape = {
|
|
2110
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2111
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2112
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2113
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2114
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2115
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2116
|
+
};
|
|
2117
|
+
const listIntentsContractV1 = base.route({
|
|
2118
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2119
|
+
method: "GET",
|
|
2120
|
+
summary: "List intents",
|
|
2121
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2122
|
+
tags: ["insights"],
|
|
2123
|
+
successDescription: "The grouped user intents"
|
|
2124
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2125
|
+
...paginatedInsightsInputShape,
|
|
2126
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2127
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2128
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2129
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2130
|
+
})).output(z.object({
|
|
2131
|
+
intents: z.array(z.object({
|
|
2132
|
+
id: z.string(),
|
|
2133
|
+
intentIds: z.array(z.string()).min(1),
|
|
2134
|
+
environmentId: z.string(),
|
|
2135
|
+
message: z.string(),
|
|
2136
|
+
toolName: z.string(),
|
|
2137
|
+
createdAt: z.coerce.date(),
|
|
2138
|
+
occurrenceCount: z.number().int().positive(),
|
|
2139
|
+
clientName: z.string().nullable(),
|
|
2140
|
+
clientId: z.string().nullable(),
|
|
2141
|
+
categories: z.array(z.object({
|
|
2142
|
+
id: z.string(),
|
|
2143
|
+
name: z.string(),
|
|
2144
|
+
color: intentCategoryColorSchema
|
|
2145
|
+
}))
|
|
2146
|
+
})),
|
|
2147
|
+
totalCount: z.number().int().nonnegative()
|
|
2148
|
+
}));
|
|
2149
|
+
const listFeedbacksContractV1 = base.route({
|
|
2150
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2151
|
+
method: "GET",
|
|
2152
|
+
summary: "List feedbacks",
|
|
2153
|
+
description: "List user feedback for an environment over a time range",
|
|
2154
|
+
tags: ["insights"],
|
|
2155
|
+
successDescription: "The user feedback"
|
|
2156
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2157
|
+
...paginatedInsightsInputShape,
|
|
2158
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2159
|
+
})).output(z.object({
|
|
2160
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2161
|
+
totalCount: z.number().int().nonnegative()
|
|
2162
|
+
}));
|
|
2163
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2164
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2165
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2166
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2167
|
+
method: "GET",
|
|
2168
|
+
summary: "List intent categories",
|
|
2169
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2170
|
+
tags: ["insights"],
|
|
2171
|
+
successDescription: "The intent categories"
|
|
2172
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2173
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2174
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2175
|
+
method: "POST",
|
|
2176
|
+
summary: "Create an intent category",
|
|
2177
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2178
|
+
tags: ["insights"],
|
|
2179
|
+
successDescription: "The created intent category"
|
|
2180
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2181
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2182
|
+
name: intentCategoryNameSchema,
|
|
2183
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2184
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2185
|
+
})).output(intentCategorySchema);
|
|
2186
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2187
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2188
|
+
method: "PATCH",
|
|
2189
|
+
summary: "Update an intent category",
|
|
2190
|
+
description: "Rename or recolor an intent category",
|
|
2191
|
+
tags: ["insights"],
|
|
2192
|
+
successDescription: "The updated intent category"
|
|
2193
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2194
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2195
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2196
|
+
name: intentCategoryNameSchema.optional(),
|
|
2197
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2198
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2199
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2200
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2201
|
+
method: "DELETE",
|
|
2202
|
+
summary: "Delete an intent category",
|
|
2203
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2204
|
+
tags: ["insights"],
|
|
2205
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2206
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2207
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2208
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2209
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2210
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2211
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2212
|
+
method: "POST",
|
|
2213
|
+
summary: "Link an intent category",
|
|
2214
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2215
|
+
tags: ["insights"],
|
|
2216
|
+
successDescription: "The intents have been linked successfully"
|
|
2217
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2218
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2219
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2220
|
+
intentIds: categorizableIntentIdsSchema
|
|
2221
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2222
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2223
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2224
|
+
method: "POST",
|
|
2225
|
+
summary: "Unlink an intent category",
|
|
2226
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2227
|
+
tags: ["insights"],
|
|
2228
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2229
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2230
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2231
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2232
|
+
intentIds: categorizableIntentIdsSchema
|
|
2233
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2234
|
+
const listTeamsContractV1 = base.route({
|
|
1942
2235
|
path: "/v1/teams",
|
|
1943
2236
|
method: "GET",
|
|
1944
2237
|
summary: "List teams",
|
|
@@ -1951,7 +2244,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1951
2244
|
createdAt: z.coerce.date(),
|
|
1952
2245
|
hasStripeAccount: z.boolean()
|
|
1953
2246
|
})));
|
|
1954
|
-
const
|
|
2247
|
+
const getTeamUsageContractV1 = base.route({
|
|
2248
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2249
|
+
method: "GET",
|
|
2250
|
+
summary: "Get team usage",
|
|
2251
|
+
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.",
|
|
2252
|
+
tags: ["teams"],
|
|
2253
|
+
successDescription: "The current billing window usage"
|
|
2254
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2255
|
+
teamId: z.string(),
|
|
2256
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2257
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2258
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2259
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2260
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2261
|
+
}));
|
|
2262
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1955
2263
|
path: "/v1/tunnels/ticket",
|
|
1956
2264
|
method: "GET",
|
|
1957
2265
|
summary: "Get a tunnel ticket",
|
|
@@ -1963,16 +2271,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1963
2271
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1964
2272
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1965
2273
|
}));
|
|
1966
|
-
const publishServerContractV1 =
|
|
2274
|
+
const publishServerContractV1 = base.route({
|
|
1967
2275
|
path: "/v1/distribution/publish",
|
|
1968
2276
|
method: "POST",
|
|
1969
2277
|
summary: "Publish a server to the MCP registry",
|
|
1970
2278
|
tags: ["distribution"],
|
|
1971
2279
|
successDescription: "The server has been published successfully"
|
|
1972
|
-
}).errors({
|
|
1973
|
-
NOT_FOUND: {},
|
|
1974
|
-
BAD_REQUEST: {}
|
|
1975
|
-
}).input(z.object({
|
|
2280
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1976
2281
|
projectId: z.string(),
|
|
1977
2282
|
domain: z.string(),
|
|
1978
2283
|
title: z.string().min(1).max(100),
|
|
@@ -1981,17 +2286,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1981
2286
|
iconSrc: z.url().max(255).optional(),
|
|
1982
2287
|
dryRun: z.boolean().optional()
|
|
1983
2288
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1984
|
-
const getServerInfoContractV1 =
|
|
2289
|
+
const getServerInfoContractV1 = base.route({
|
|
1985
2290
|
path: "/v1/distribution/get",
|
|
1986
2291
|
method: "GET",
|
|
1987
2292
|
summary: "Get server info",
|
|
1988
2293
|
description: "Get info about a server",
|
|
1989
2294
|
tags: ["distribution"],
|
|
1990
2295
|
successDescription: "The server info"
|
|
1991
|
-
}).errors({
|
|
1992
|
-
NOT_FOUND: {},
|
|
1993
|
-
BAD_REQUEST: {}
|
|
1994
|
-
}).input(z.object({
|
|
2296
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1995
2297
|
projectId: z.string(),
|
|
1996
2298
|
domain: z.string()
|
|
1997
2299
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -2010,7 +2312,7 @@ const playgroundOutputSchema = z.object({
|
|
|
2010
2312
|
isPlaygroundEnabled: z.boolean(),
|
|
2011
2313
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
2012
2314
|
});
|
|
2013
|
-
const getPlaygroundContractV1 =
|
|
2315
|
+
const getPlaygroundContractV1 = base.route({
|
|
2014
2316
|
path: "/v1/environments/{environmentId}/playground",
|
|
2015
2317
|
method: "GET",
|
|
2016
2318
|
summary: "Get playground configuration",
|
|
@@ -2018,17 +2320,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
2018
2320
|
tags: ["environments"],
|
|
2019
2321
|
successDescription: "The playground configuration"
|
|
2020
2322
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
2021
|
-
const upsertPlaygroundContractV1 =
|
|
2323
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
2022
2324
|
path: "/v1/environments/{environmentId}/playground",
|
|
2023
2325
|
method: "PUT",
|
|
2024
2326
|
summary: "Update playground configuration",
|
|
2025
2327
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
2026
2328
|
tags: ["environments"],
|
|
2027
2329
|
successDescription: "The updated playground configuration"
|
|
2028
|
-
}).errors({
|
|
2029
|
-
NOT_FOUND: {},
|
|
2030
|
-
BAD_REQUEST: {}
|
|
2031
|
-
}).input(z.object({
|
|
2330
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2032
2331
|
environmentId: z.string().describe("The ID of the environment"),
|
|
2033
2332
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
2034
2333
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -2036,7 +2335,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
2036
2335
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
2037
2336
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
2038
2337
|
})).output(playgroundOutputSchema);
|
|
2039
|
-
const createBeaconContractV1 =
|
|
2338
|
+
const createBeaconContractV1 = base.route({
|
|
2040
2339
|
path: "/v1/beacon/audits",
|
|
2041
2340
|
method: "POST",
|
|
2042
2341
|
summary: "Create a beacon audit",
|
|
@@ -2045,7 +2344,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
2045
2344
|
successDescription: "The audit has been created"
|
|
2046
2345
|
}).errors({
|
|
2047
2346
|
NOT_FOUND: {},
|
|
2048
|
-
BAD_REQUEST: {},
|
|
2049
2347
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
2050
2348
|
}).input(z.object({
|
|
2051
2349
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -2053,7 +2351,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
2053
2351
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
2054
2352
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
2055
2353
|
})).output(z.object({ id: z.string() }));
|
|
2056
|
-
const getBeaconContractV1 =
|
|
2354
|
+
const getBeaconContractV1 = base.route({
|
|
2057
2355
|
path: "/v1/beacon/audits/{auditId}",
|
|
2058
2356
|
method: "GET",
|
|
2059
2357
|
summary: "Get a beacon audit",
|
|
@@ -2068,9 +2366,61 @@ const getBeaconContractV1 = oc.route({
|
|
|
2068
2366
|
createdAt: z.coerce.date(),
|
|
2069
2367
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
2070
2368
|
}));
|
|
2369
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2370
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2371
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2372
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2373
|
+
const createSubmissionContractV1 = base.route({
|
|
2374
|
+
path: "/v1/submissions",
|
|
2375
|
+
method: "POST",
|
|
2376
|
+
summary: "Create a submission package",
|
|
2377
|
+
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.",
|
|
2378
|
+
tags: ["submissions"],
|
|
2379
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2380
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2381
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2382
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2383
|
+
})).output(submissionSchema);
|
|
2384
|
+
const getSubmissionContractV1 = base.route({
|
|
2385
|
+
path: "/v1/submissions/{submissionId}",
|
|
2386
|
+
method: "GET",
|
|
2387
|
+
summary: "Get a submission package",
|
|
2388
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2389
|
+
tags: ["submissions"],
|
|
2390
|
+
successDescription: "The submission package"
|
|
2391
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2392
|
+
const updateSubmissionContractV1 = base.route({
|
|
2393
|
+
path: "/v1/submissions/{submissionId}",
|
|
2394
|
+
method: "PUT",
|
|
2395
|
+
summary: "Update a submission package",
|
|
2396
|
+
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.",
|
|
2397
|
+
tags: ["submissions"],
|
|
2398
|
+
successDescription: "The updated submission package"
|
|
2399
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2400
|
+
submissionId: submissionIdSchema,
|
|
2401
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2402
|
+
formData: claudeSubmissionUpdateSchema
|
|
2403
|
+
}), z.object({
|
|
2404
|
+
submissionId: submissionIdSchema,
|
|
2405
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2406
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2407
|
+
})])).output(submissionSchema);
|
|
2071
2408
|
const contract = {
|
|
2072
|
-
teams: {
|
|
2409
|
+
teams: {
|
|
2410
|
+
list: { v1: listTeamsContractV1 },
|
|
2411
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2412
|
+
},
|
|
2073
2413
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2414
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2415
|
+
intentCategories: {
|
|
2416
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2417
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2418
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2419
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2420
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2421
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2422
|
+
},
|
|
2423
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
2074
2424
|
deployments: {
|
|
2075
2425
|
list: { v1: listDeploymentsContractV1 },
|
|
2076
2426
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -2080,6 +2430,7 @@ const contract = {
|
|
|
2080
2430
|
environments: {
|
|
2081
2431
|
create: { v1: createEnvironmentContractV1 },
|
|
2082
2432
|
get: { v1: getEnvironmentContractV1 },
|
|
2433
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
2083
2434
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
2084
2435
|
getLogs: { v1: getLogsContractV1 },
|
|
2085
2436
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -2109,6 +2460,11 @@ const contract = {
|
|
|
2109
2460
|
beacon: {
|
|
2110
2461
|
create: { v1: createBeaconContractV1 },
|
|
2111
2462
|
get: { v1: getBeaconContractV1 }
|
|
2463
|
+
},
|
|
2464
|
+
submissions: {
|
|
2465
|
+
create: { v1: createSubmissionContractV1 },
|
|
2466
|
+
get: { v1: getSubmissionContractV1 },
|
|
2467
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2112
2468
|
}
|
|
2113
2469
|
};
|
|
2114
2470
|
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
@@ -2116,5 +2472,26 @@ const contractForDocs = {
|
|
|
2116
2472
|
...contract,
|
|
2117
2473
|
deployments: deploymentsForDocs
|
|
2118
2474
|
};
|
|
2475
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2476
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2477
|
+
info: {
|
|
2478
|
+
title: "Alpic API",
|
|
2479
|
+
version: "1.0.0"
|
|
2480
|
+
},
|
|
2481
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2482
|
+
security: [{ bearerAuth: [] }],
|
|
2483
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2484
|
+
type: "http",
|
|
2485
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2486
|
+
scheme: "bearer"
|
|
2487
|
+
} } },
|
|
2488
|
+
commonSchemas: {
|
|
2489
|
+
Submission: { schema: submissionSchema },
|
|
2490
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2491
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2492
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2493
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
2494
|
+
}
|
|
2495
|
+
};
|
|
2119
2496
|
//#endregion
|
|
2120
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2497
|
+
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 };
|