@alpic-ai/api 0.0.0-dev.gda044d0 → 0.0.0-dev.gda34b6b
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 +5194 -55
- package/dist/index.mjs +428 -57
- package/package.json +8 -8
package/dist/index.mjs
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
import * as z$1 from "zod/v4";
|
|
3
3
|
import { oc } from "@orpc/contract";
|
|
4
4
|
import ms from "ms";
|
|
5
|
-
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.32.1_supports-color@8.1.1_zod@4.5.4/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -119,7 +119,12 @@ z$1.object({
|
|
|
119
119
|
token_type: z$1.string(),
|
|
120
120
|
expires_in: z$1.coerce.number().optional(),
|
|
121
121
|
scope: z$1.string().optional(),
|
|
122
|
-
refresh_token: z$1.string().optional()
|
|
122
|
+
refresh_token: z$1.string().optional(),
|
|
123
|
+
/**
|
|
124
|
+
* Not part of the wire format: the authorization server this value was obtained from, added by
|
|
125
|
+
* the client's `auth()` before it is stored and compared when it is read back.
|
|
126
|
+
*/
|
|
127
|
+
issuer: z$1.string().optional().catch(void 0)
|
|
123
128
|
}).strip();
|
|
124
129
|
z$1.object({
|
|
125
130
|
error: z$1.string(),
|
|
@@ -158,7 +163,12 @@ const OAuthClientInformationSchema = z$1.object({
|
|
|
158
163
|
client_id: z$1.string(),
|
|
159
164
|
client_secret: z$1.string().optional(),
|
|
160
165
|
client_id_issued_at: z$1.number().optional(),
|
|
161
|
-
client_secret_expires_at: z$1.number().optional()
|
|
166
|
+
client_secret_expires_at: z$1.number().optional(),
|
|
167
|
+
/**
|
|
168
|
+
* Not part of the wire format: the authorization server this value was obtained from, added by
|
|
169
|
+
* the client's `auth()` before it is stored and compared when it is read back.
|
|
170
|
+
*/
|
|
171
|
+
issuer: z$1.string().optional().catch(void 0)
|
|
162
172
|
}).strip();
|
|
163
173
|
OAuthClientMetadataSchema.merge(OAuthClientInformationSchema);
|
|
164
174
|
z$1.object({
|
|
@@ -179,6 +189,7 @@ const PLATFORM_LABELS = {
|
|
|
179
189
|
};
|
|
180
190
|
const WAF_PLATFORMS = [
|
|
181
191
|
"akamai",
|
|
192
|
+
"cato",
|
|
182
193
|
"cloudflare",
|
|
183
194
|
"fastly"
|
|
184
195
|
];
|
|
@@ -256,16 +267,25 @@ z.object({
|
|
|
256
267
|
clientSecret: z.string(),
|
|
257
268
|
clientScopes: z.array(z.string())
|
|
258
269
|
});
|
|
259
|
-
z.enum([
|
|
260
|
-
"opening_balance",
|
|
270
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
271
|
"free_seed",
|
|
262
272
|
"paid_conversion_floor",
|
|
263
273
|
"top_up",
|
|
264
274
|
"usage",
|
|
265
|
-
"refund",
|
|
266
275
|
"admin_adjustment"
|
|
267
276
|
]);
|
|
268
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
|
+
});
|
|
269
289
|
const deploymentStatusSchema$1 = z.enum([
|
|
270
290
|
"ongoing",
|
|
271
291
|
"deployed",
|
|
@@ -326,7 +346,8 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
326
346
|
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
327
347
|
allowsAnonymous: z.literal(false),
|
|
328
348
|
oAuthMetadata: z.strictObject({}),
|
|
329
|
-
scope: z.string().optional()
|
|
349
|
+
scope: z.string().optional(),
|
|
350
|
+
wwwAuthenticate: z.string().optional()
|
|
330
351
|
});
|
|
331
352
|
const legacyPublicEnvironmentSchema = z.object({
|
|
332
353
|
isPublic: z.literal(true),
|
|
@@ -371,10 +392,13 @@ z.union([
|
|
|
371
392
|
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
372
393
|
]);
|
|
373
394
|
const playgroundModelSchema = z.enum([
|
|
395
|
+
"global.anthropic.claude-haiku-5-5",
|
|
374
396
|
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
375
|
-
"global.anthropic.claude-sonnet-
|
|
397
|
+
"global.anthropic.claude-sonnet-5-5",
|
|
376
398
|
"openai.gpt-5.4",
|
|
377
|
-
"openai.gpt-5.5"
|
|
399
|
+
"openai.gpt-5.5",
|
|
400
|
+
"openai.gpt-6-luna",
|
|
401
|
+
"openai.gpt-6.1-sol"
|
|
378
402
|
]);
|
|
379
403
|
const environmentDomainSchema = z.object({
|
|
380
404
|
name: z.string(),
|
|
@@ -410,7 +434,8 @@ z.object({
|
|
|
410
434
|
collectResponsePayload: z.boolean(),
|
|
411
435
|
collectErrorMessage: z.boolean(),
|
|
412
436
|
collectUserData: z.boolean(),
|
|
413
|
-
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
437
|
+
identityTraitKey: z.string().min(1).max(200).nullable(),
|
|
438
|
+
leadEventName: z.string().min(1).max(200).nullable()
|
|
414
439
|
});
|
|
415
440
|
const feedbackSchema = z.object({
|
|
416
441
|
id: z.string(),
|
|
@@ -513,12 +538,30 @@ z.object({
|
|
|
513
538
|
createdAt: z.coerce.date(),
|
|
514
539
|
updatedAt: z.coerce.date()
|
|
515
540
|
});
|
|
541
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
542
|
+
type: z.literal("mcp_request"),
|
|
543
|
+
method: z.string()
|
|
544
|
+
});
|
|
545
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
546
|
+
type: z.literal("mcp_error"),
|
|
547
|
+
method: z.string(),
|
|
548
|
+
error: z.string()
|
|
549
|
+
});
|
|
550
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
516
551
|
z.enum([
|
|
517
552
|
"INFO",
|
|
518
553
|
"WARNING",
|
|
519
554
|
"DEBUG",
|
|
520
555
|
"ERROR"
|
|
521
556
|
]);
|
|
557
|
+
const LOG_SEARCH_MAX_ESCAPED_LENGTH = 960;
|
|
558
|
+
function escapeLogSearchTerm(search) {
|
|
559
|
+
return [...search].flatMap((character) => [...new TextEncoder().encode(character)]).map((byte) => {
|
|
560
|
+
const character = String.fromCharCode(byte);
|
|
561
|
+
return /^[a-zA-Z0-9]$/.test(character) ? character : `\\x${byte.toString(16).toUpperCase().padStart(2, "0")}`;
|
|
562
|
+
}).join("");
|
|
563
|
+
}
|
|
564
|
+
const logSearchSchema = z.string().max(240, `Search must be 240 characters or fewer`).refine((search) => escapeLogSearchTerm(search).length <= LOG_SEARCH_MAX_ESCAPED_LENGTH, "Search is too complex; shorten it or use fewer special characters");
|
|
522
565
|
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
523
566
|
const MCP_CLIENT_GROUPS = [
|
|
524
567
|
{
|
|
@@ -586,7 +629,7 @@ const MCP_CLIENT_GROUPS = [
|
|
|
586
629
|
id: "chatgpt",
|
|
587
630
|
label: "ChatGPT",
|
|
588
631
|
vendor: "openai",
|
|
589
|
-
rawNames: ["openai-mcp (ChatGPT)"]
|
|
632
|
+
rawNames: ["openai-mcp", "openai-mcp (ChatGPT)"]
|
|
590
633
|
},
|
|
591
634
|
{
|
|
592
635
|
id: "openai_responses_api",
|
|
@@ -600,12 +643,6 @@ const MCP_CLIENT_GROUPS = [
|
|
|
600
643
|
vendor: "openai",
|
|
601
644
|
rawNames: ["openai-mcp (Agent Builder)"]
|
|
602
645
|
},
|
|
603
|
-
{
|
|
604
|
-
id: "openai_other",
|
|
605
|
-
label: "OpenAI Other",
|
|
606
|
-
vendor: "openai",
|
|
607
|
-
rawNames: ["openai-mcp"]
|
|
608
|
-
},
|
|
609
646
|
{
|
|
610
647
|
id: "cursor",
|
|
611
648
|
label: "Cursor",
|
|
@@ -844,6 +881,10 @@ const clampStringField = (field) => {
|
|
|
844
881
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
845
882
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
846
883
|
};
|
|
884
|
+
const unboundedArrayField = (field) => {
|
|
885
|
+
const unbounded = z.array(field.element);
|
|
886
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
887
|
+
};
|
|
847
888
|
const toolDefinitionSchema = z.object({
|
|
848
889
|
name: z.string(),
|
|
849
890
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -856,11 +897,22 @@ const toolDefinitionSchema = z.object({
|
|
|
856
897
|
}).optional()
|
|
857
898
|
});
|
|
858
899
|
const positiveTestCaseSchema = z.object({
|
|
859
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
860
|
-
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."),
|
|
900
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
901
|
+
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."),
|
|
861
902
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
862
903
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
863
|
-
}).
|
|
904
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
905
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
906
|
+
scenario: z.string().optional(),
|
|
907
|
+
userPrompt: z.string().optional()
|
|
908
|
+
});
|
|
909
|
+
const blankPositiveTestCase = () => ({
|
|
910
|
+
scenario: "",
|
|
911
|
+
userPrompt: "",
|
|
912
|
+
toolTriggered: "",
|
|
913
|
+
expectedOutput: ""
|
|
914
|
+
});
|
|
915
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
864
916
|
const screenshotEntrySchema = z.object({
|
|
865
917
|
prompt: z.string(),
|
|
866
918
|
url: z.url()
|
|
@@ -1173,9 +1225,18 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
1173
1225
|
"zh-TW"
|
|
1174
1226
|
]);
|
|
1175
1227
|
const negativeTestCaseSchema = z.object({
|
|
1176
|
-
scenario: z.string(),
|
|
1177
|
-
userPrompt: z.string()
|
|
1178
|
-
}).
|
|
1228
|
+
scenario: z.string().min(1),
|
|
1229
|
+
userPrompt: z.string().min(1)
|
|
1230
|
+
}).describe("Each case: Scenario + User prompt (the plugin should NOT trigger).");
|
|
1231
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1232
|
+
scenario: z.string().optional(),
|
|
1233
|
+
userPrompt: z.string().optional()
|
|
1234
|
+
});
|
|
1235
|
+
const blankNegativeTestCase = () => ({
|
|
1236
|
+
scenario: "",
|
|
1237
|
+
userPrompt: ""
|
|
1238
|
+
});
|
|
1239
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
1179
1240
|
const chatgptToolJustificationSchema = z.object({
|
|
1180
1241
|
toolName: z.string(),
|
|
1181
1242
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
@@ -1195,27 +1256,28 @@ chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema
|
|
|
1195
1256
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
1196
1257
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
1197
1258
|
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."),
|
|
1198
|
-
appName: z.string().describe("The name users will see in ChatGPT and in the
|
|
1259
|
+
appName: z.string().describe("The name users will see in ChatGPT and in the Plugin Directory."),
|
|
1199
1260
|
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
1200
|
-
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the
|
|
1261
|
+
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)."),
|
|
1201
1262
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
1202
|
-
developerName: z.string().describe("Developer name shown publicly on the
|
|
1263
|
+
developerName: z.string().describe("Developer name shown publicly on the plugin's directory page."),
|
|
1203
1264
|
companyUrl: urlField.describe("Your company's main website URL."),
|
|
1204
1265
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
1205
1266
|
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1206
|
-
termsOfServiceUrl: urlField.describe("URL to the
|
|
1207
|
-
demoRecordingUrl: urlField.describe("URL to a video demonstrating the
|
|
1208
|
-
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My
|
|
1267
|
+
termsOfServiceUrl: urlField.describe("URL to the plugin's terms of service."),
|
|
1268
|
+
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."),
|
|
1269
|
+
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."),
|
|
1209
1270
|
serverUrl: urlField.describe("URL of the MCP server."),
|
|
1210
1271
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
1211
1272
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1212
1273
|
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."),
|
|
1213
|
-
|
|
1214
|
-
|
|
1215
|
-
|
|
1274
|
+
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."),
|
|
1275
|
+
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."),
|
|
1276
|
+
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."),
|
|
1277
|
+
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."),
|
|
1216
1278
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1217
1279
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
1218
|
-
releaseNotes: z.string().describe("Publicly displayed on the
|
|
1280
|
+
releaseNotes: z.string().describe("Publicly displayed on the plugin details page.")
|
|
1219
1281
|
});
|
|
1220
1282
|
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1221
1283
|
tagline: z.string().optional(),
|
|
@@ -1226,23 +1288,35 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
1226
1288
|
demoRecordingUrl: z.string().optional(),
|
|
1227
1289
|
serverUrl: z.string().optional(),
|
|
1228
1290
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1291
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1292
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1229
1293
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1230
1294
|
});
|
|
1231
|
-
|
|
1295
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1296
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1232
1297
|
appName: true,
|
|
1233
1298
|
developerName: true,
|
|
1234
1299
|
serverUrl: true,
|
|
1235
1300
|
tools: true,
|
|
1301
|
+
skills: true,
|
|
1236
1302
|
authentication: true
|
|
1237
1303
|
});
|
|
1238
|
-
|
|
1304
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1305
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1239
1306
|
tagline: true,
|
|
1240
1307
|
description: true,
|
|
1241
1308
|
category: true,
|
|
1242
1309
|
testCases: true,
|
|
1243
1310
|
negativeTestCases: true,
|
|
1244
1311
|
toolJustifications: true
|
|
1245
|
-
}).extend({
|
|
1312
|
+
}).extend({
|
|
1313
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1314
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1315
|
+
}).extend({
|
|
1316
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1317
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1318
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1319
|
+
});
|
|
1246
1320
|
const claudeCategorySchema = z.enum([
|
|
1247
1321
|
"Productivity",
|
|
1248
1322
|
"Communication",
|
|
@@ -1365,7 +1439,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1365
1439
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1366
1440
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1367
1441
|
});
|
|
1368
|
-
|
|
1442
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1443
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1369
1444
|
serverUrl: true,
|
|
1370
1445
|
name: true,
|
|
1371
1446
|
slug: true,
|
|
@@ -1387,27 +1462,81 @@ const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
|
1387
1462
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1388
1463
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1389
1464
|
});
|
|
1390
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1465
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1391
1466
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1392
1467
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1393
1468
|
});
|
|
1469
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1470
|
+
const byField = {};
|
|
1471
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1472
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1473
|
+
return byField;
|
|
1474
|
+
}
|
|
1475
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1476
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1477
|
+
"pass",
|
|
1478
|
+
"fail",
|
|
1479
|
+
"unverified"
|
|
1480
|
+
]);
|
|
1481
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1482
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1483
|
+
claudeai: ["privacyPolicy"]
|
|
1484
|
+
};
|
|
1485
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1486
|
+
const policyDisclosureSchema = z.enum([
|
|
1487
|
+
"dataCategories",
|
|
1488
|
+
"purposesOfUse",
|
|
1489
|
+
"recipients",
|
|
1490
|
+
"retention"
|
|
1491
|
+
]);
|
|
1492
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1493
|
+
field: verifiableUrlFieldSchema,
|
|
1494
|
+
url: z.string(),
|
|
1495
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1496
|
+
reason: z.string(),
|
|
1497
|
+
concerns: z.array(z.string()).optional(),
|
|
1498
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1499
|
+
});
|
|
1500
|
+
const urlVerificationSchema = z.object({
|
|
1501
|
+
verifiedAt: z.coerce.date(),
|
|
1502
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1503
|
+
});
|
|
1504
|
+
const pageKindSchema = z.enum([
|
|
1505
|
+
"expectedDocument",
|
|
1506
|
+
"errorPage",
|
|
1507
|
+
"loginWall",
|
|
1508
|
+
"parkedDomain",
|
|
1509
|
+
"comingSoon",
|
|
1510
|
+
"marketingPage",
|
|
1511
|
+
"unrelatedDocument"
|
|
1512
|
+
]);
|
|
1513
|
+
z.object({
|
|
1514
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1515
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1516
|
+
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.")
|
|
1517
|
+
});
|
|
1394
1518
|
const submissionMetaFieldsSchema = z.object({
|
|
1395
1519
|
id: z.string(),
|
|
1396
1520
|
environmentId: z.string(),
|
|
1397
1521
|
auditId: z.string().nullable(),
|
|
1522
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1398
1523
|
createdAt: z.coerce.date(),
|
|
1399
1524
|
updatedAt: z.coerce.date()
|
|
1400
1525
|
});
|
|
1401
1526
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1402
1527
|
platform: z.literal("claudeai"),
|
|
1403
|
-
formData: claudeSubmissionDraftSchema
|
|
1528
|
+
formData: claudeSubmissionDraftSchema,
|
|
1529
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1404
1530
|
});
|
|
1405
1531
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1406
1532
|
platform: z.literal("chatgpt"),
|
|
1407
|
-
formData: chatgptSubmissionDraftSchema
|
|
1533
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1534
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1408
1535
|
});
|
|
1409
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1536
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1410
1537
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1538
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1539
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1411
1540
|
z.literal([
|
|
1412
1541
|
100,
|
|
1413
1542
|
75,
|
|
@@ -1424,31 +1553,78 @@ const customerCreditsSchema = z.object({
|
|
|
1424
1553
|
expiresAt: z.number().nullable(),
|
|
1425
1554
|
currency: z.string()
|
|
1426
1555
|
});
|
|
1427
|
-
const customerUsageSchema = z.object({
|
|
1428
|
-
amountInCents: z.number(),
|
|
1429
|
-
currency: z.string(),
|
|
1430
|
-
periodEnd: z.number()
|
|
1431
|
-
});
|
|
1432
1556
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1433
|
-
z.object({ balanceInNanoUSD: z.number() });
|
|
1434
1557
|
z.object({
|
|
1435
1558
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1436
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1437
1559
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1438
1560
|
});
|
|
1439
|
-
const
|
|
1561
|
+
const metricsQueueEventSchema = z.object({
|
|
1562
|
+
ts: z.number().int(),
|
|
1563
|
+
method: z.string(),
|
|
1564
|
+
tool: z.string().nullable(),
|
|
1565
|
+
client: z.string(),
|
|
1566
|
+
sessionId: z.string().nullable(),
|
|
1567
|
+
conversationId: z.string().nullable().optional(),
|
|
1568
|
+
durationMs: z.number().int(),
|
|
1569
|
+
outputTokens: z.number().int().nullable(),
|
|
1570
|
+
errorType: z.enum([
|
|
1571
|
+
"mcp_error",
|
|
1572
|
+
"tool_error",
|
|
1573
|
+
"timeout"
|
|
1574
|
+
]).nullable(),
|
|
1575
|
+
errorCode: z.number().int().nullable()
|
|
1576
|
+
});
|
|
1577
|
+
z.object({
|
|
1578
|
+
v: z.literal(1),
|
|
1579
|
+
envId: z.string(),
|
|
1580
|
+
events: z.array(metricsQueueEventSchema)
|
|
1581
|
+
});
|
|
1582
|
+
z.object({ v: z.number() });
|
|
1583
|
+
const TELEMETRY_SIGNALS = [
|
|
1440
1584
|
"logs",
|
|
1441
1585
|
"metrics",
|
|
1442
1586
|
"traces"
|
|
1443
|
-
]
|
|
1444
|
-
const
|
|
1587
|
+
];
|
|
1588
|
+
const telemetrySignalSchema = z.enum(TELEMETRY_SIGNALS);
|
|
1589
|
+
const OTLP_PROTOCOLS = ["http/protobuf", "http/json"];
|
|
1590
|
+
const otlpProtocolSchema = z.enum(OTLP_PROTOCOLS);
|
|
1445
1591
|
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1592
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1593
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1594
|
+
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");
|
|
1595
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1596
|
+
id: z.string(),
|
|
1597
|
+
name: otlpHeaderNameSchema,
|
|
1598
|
+
value: otlpHeaderValueSchema,
|
|
1599
|
+
isSecret: z.boolean()
|
|
1600
|
+
});
|
|
1601
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1602
|
+
"credentials",
|
|
1603
|
+
"wrong-path",
|
|
1604
|
+
"wrong-protocol",
|
|
1605
|
+
"invalid-payload",
|
|
1606
|
+
"partial-rejection",
|
|
1607
|
+
"blocked-target",
|
|
1608
|
+
"timeout",
|
|
1609
|
+
"unreachable",
|
|
1610
|
+
"receiver-error",
|
|
1611
|
+
"unexpected-status"
|
|
1612
|
+
]);
|
|
1613
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1446
1614
|
z.object({
|
|
1447
1615
|
id: z.string(),
|
|
1448
1616
|
signal: telemetrySignalSchema,
|
|
1449
1617
|
endpoint: otlpEndpointSchema,
|
|
1450
|
-
protocol: otlpProtocolSchema
|
|
1451
|
-
|
|
1618
|
+
protocol: otlpProtocolSchema,
|
|
1619
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1620
|
+
status: telemetryDestinationStatusSchema,
|
|
1621
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable(),
|
|
1622
|
+
isScopedToIntentionalRequestsOnly: z.boolean()
|
|
1623
|
+
});
|
|
1624
|
+
const hasDuplicateHeaderNames = (headers) => {
|
|
1625
|
+
const names = headers.map(({ name }) => name.trim().toLowerCase());
|
|
1626
|
+
return new Set(names).size !== names.length;
|
|
1627
|
+
};
|
|
1452
1628
|
//#endregion
|
|
1453
1629
|
//#region src/auth-scope.ts
|
|
1454
1630
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1547,6 +1723,14 @@ const serverFieldsSchema = z.object({
|
|
|
1547
1723
|
});
|
|
1548
1724
|
//#endregion
|
|
1549
1725
|
//#region src/api.contract.ts
|
|
1726
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1727
|
+
try {
|
|
1728
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1729
|
+
return true;
|
|
1730
|
+
} catch {
|
|
1731
|
+
return false;
|
|
1732
|
+
}
|
|
1733
|
+
};
|
|
1550
1734
|
const deploymentStatusSchema = z.enum([
|
|
1551
1735
|
"ongoing",
|
|
1552
1736
|
"deployed",
|
|
@@ -1617,6 +1801,14 @@ const getEnvironmentContractV1 = base.route({
|
|
|
1617
1801
|
createdAt: z.coerce.date(),
|
|
1618
1802
|
projectId: z.string()
|
|
1619
1803
|
}));
|
|
1804
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1805
|
+
path: "/v1/environments/{environmentId}",
|
|
1806
|
+
method: "DELETE",
|
|
1807
|
+
summary: "Delete an environment",
|
|
1808
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1809
|
+
tags: ["environments"],
|
|
1810
|
+
successDescription: "The environment has been deleted successfully"
|
|
1811
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1620
1812
|
const domainSchema = z.object({
|
|
1621
1813
|
domain: z.string(),
|
|
1622
1814
|
status: z.enum([
|
|
@@ -1723,6 +1915,100 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1723
1915
|
isSecret: z.boolean(),
|
|
1724
1916
|
createdAt: z.coerce.date()
|
|
1725
1917
|
});
|
|
1918
|
+
const telemetryDestinationHeaderOutputSchema = z.discriminatedUnion("isSecret", [z.object({
|
|
1919
|
+
id: z.string(),
|
|
1920
|
+
name: otlpHeaderNameSchema,
|
|
1921
|
+
value: z.null(),
|
|
1922
|
+
isSecret: z.literal(true)
|
|
1923
|
+
}), z.object({
|
|
1924
|
+
id: z.string(),
|
|
1925
|
+
name: otlpHeaderNameSchema,
|
|
1926
|
+
value: otlpHeaderValueSchema,
|
|
1927
|
+
isSecret: z.literal(false)
|
|
1928
|
+
})]);
|
|
1929
|
+
const telemetryDestinationOutputSchema = z.object({
|
|
1930
|
+
id: z.string(),
|
|
1931
|
+
signal: telemetrySignalSchema,
|
|
1932
|
+
endpoint: otlpEndpointSchema,
|
|
1933
|
+
protocol: otlpProtocolSchema,
|
|
1934
|
+
headers: z.array(telemetryDestinationHeaderOutputSchema),
|
|
1935
|
+
status: telemetryDestinationStatusSchema,
|
|
1936
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable(),
|
|
1937
|
+
isScopedToIntentionalRequestsOnly: z.boolean()
|
|
1938
|
+
});
|
|
1939
|
+
const createTelemetryDestinationHeaderInputSchema = z.object({
|
|
1940
|
+
name: otlpHeaderNameSchema,
|
|
1941
|
+
value: otlpHeaderValueSchema.min(1, "Enter a header value"),
|
|
1942
|
+
isSecret: z.boolean()
|
|
1943
|
+
});
|
|
1944
|
+
const updateTelemetryDestinationHeaderInputSchema = z.object({
|
|
1945
|
+
id: z.string().optional(),
|
|
1946
|
+
name: otlpHeaderNameSchema,
|
|
1947
|
+
value: otlpHeaderValueSchema.optional(),
|
|
1948
|
+
isSecret: z.boolean()
|
|
1949
|
+
});
|
|
1950
|
+
const uniqueTelemetryHeaders = (headers) => !hasDuplicateHeaderNames(headers);
|
|
1951
|
+
const listTelemetryDestinationsContractV1 = base.route({
|
|
1952
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations",
|
|
1953
|
+
method: "GET",
|
|
1954
|
+
summary: "List telemetry destinations",
|
|
1955
|
+
description: "List the OTLP destinations configured for an environment. Secret header values are never returned.",
|
|
1956
|
+
tags: ["telemetry"],
|
|
1957
|
+
successDescription: "The list of telemetry destinations"
|
|
1958
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(telemetryDestinationOutputSchema));
|
|
1959
|
+
const createTelemetryDestinationContractV1 = base.route({
|
|
1960
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations",
|
|
1961
|
+
method: "POST",
|
|
1962
|
+
summary: "Create a telemetry destination",
|
|
1963
|
+
description: "Verify and save an OTLP destination for logs, metrics, or traces.",
|
|
1964
|
+
tags: ["telemetry"],
|
|
1965
|
+
successDescription: "The telemetry destination has been created"
|
|
1966
|
+
}).errors({
|
|
1967
|
+
NOT_FOUND: {},
|
|
1968
|
+
FORBIDDEN: {},
|
|
1969
|
+
OTLP_DESTINATION_UNVERIFIED: { status: 400 },
|
|
1970
|
+
INTERNAL_SERVER_ERROR: {}
|
|
1971
|
+
}).input(z.object({
|
|
1972
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1973
|
+
signal: telemetrySignalSchema,
|
|
1974
|
+
endpoint: otlpEndpointSchema,
|
|
1975
|
+
protocol: otlpProtocolSchema.default("http/protobuf"),
|
|
1976
|
+
isScopedToIntentionalRequestsOnly: z.boolean().default(false),
|
|
1977
|
+
headers: z.array(createTelemetryDestinationHeaderInputSchema).default([]).refine(uniqueTelemetryHeaders, "Header names must be unique")
|
|
1978
|
+
})).output(telemetryDestinationOutputSchema);
|
|
1979
|
+
const updateTelemetryDestinationContractV1 = base.route({
|
|
1980
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations/{destinationId}",
|
|
1981
|
+
method: "PATCH",
|
|
1982
|
+
summary: "Update a telemetry destination",
|
|
1983
|
+
description: "Verify and save changes to an OTLP destination. Omit headers to keep them unchanged; omit the value of an existing header to preserve it. A secret header value must be re-entered when the endpoint changes.",
|
|
1984
|
+
tags: ["telemetry"],
|
|
1985
|
+
successDescription: "The telemetry destination has been updated"
|
|
1986
|
+
}).errors({
|
|
1987
|
+
NOT_FOUND: {},
|
|
1988
|
+
FORBIDDEN: {},
|
|
1989
|
+
OTLP_DESTINATION_UNVERIFIED: { status: 400 }
|
|
1990
|
+
}).input(z.object({
|
|
1991
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1992
|
+
destinationId: z.string().describe("The ID of the telemetry destination"),
|
|
1993
|
+
endpoint: otlpEndpointSchema.optional(),
|
|
1994
|
+
protocol: otlpProtocolSchema.optional(),
|
|
1995
|
+
isScopedToIntentionalRequestsOnly: z.boolean().optional(),
|
|
1996
|
+
headers: z.array(updateTelemetryDestinationHeaderInputSchema).refine(uniqueTelemetryHeaders, "Header names must be unique").optional()
|
|
1997
|
+
})).output(telemetryDestinationOutputSchema);
|
|
1998
|
+
const deleteTelemetryDestinationContractV1 = base.route({
|
|
1999
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations/{destinationId}",
|
|
2000
|
+
method: "DELETE",
|
|
2001
|
+
summary: "Delete a telemetry destination",
|
|
2002
|
+
description: "Delete an OTLP destination from an environment.",
|
|
2003
|
+
tags: ["telemetry"],
|
|
2004
|
+
successDescription: "The telemetry destination has been deleted"
|
|
2005
|
+
}).errors({
|
|
2006
|
+
NOT_FOUND: {},
|
|
2007
|
+
INTERNAL_SERVER_ERROR: {}
|
|
2008
|
+
}).input(z.object({
|
|
2009
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2010
|
+
destinationId: z.string().describe("The ID of the telemetry destination")
|
|
2011
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
1726
2012
|
const listEnvironmentVariablesContractV1 = base.route({
|
|
1727
2013
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1728
2014
|
method: "GET",
|
|
@@ -1866,7 +2152,7 @@ const getLogsContractV1 = base.route({
|
|
|
1866
2152
|
"WARNING",
|
|
1867
2153
|
"DEBUG"
|
|
1868
2154
|
])).optional().describe("Filter by log level"),
|
|
1869
|
-
search:
|
|
2155
|
+
search: logSearchSchema.optional().describe("Term to search for in log content"),
|
|
1870
2156
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1871
2157
|
})).output(z.object({
|
|
1872
2158
|
logs: z.array(logEntrySchema),
|
|
@@ -1888,7 +2174,7 @@ const getLatestLogsContractV1 = base.route({
|
|
|
1888
2174
|
"WARNING",
|
|
1889
2175
|
"DEBUG"
|
|
1890
2176
|
])).optional().describe("Filter by log level"),
|
|
1891
|
-
search:
|
|
2177
|
+
search: logSearchSchema.optional().describe("Term to search for in log content")
|
|
1892
2178
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1893
2179
|
const getDeploymentLogsContractV1 = base.route({
|
|
1894
2180
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
@@ -1929,7 +2215,7 @@ const getProjectAnalyticsContractV1 = base.route({
|
|
|
1929
2215
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1930
2216
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1931
2217
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1932
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2218
|
+
}).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({
|
|
1933
2219
|
metadata: z.object({
|
|
1934
2220
|
startTimestamp: z.number(),
|
|
1935
2221
|
endTimestamp: z.number(),
|
|
@@ -2199,6 +2485,57 @@ const getBeaconContractV1 = base.route({
|
|
|
2199
2485
|
createdAt: z.coerce.date(),
|
|
2200
2486
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
2201
2487
|
}));
|
|
2488
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2489
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2490
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2491
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2492
|
+
const createSubmissionContractV1 = base.route({
|
|
2493
|
+
path: "/v1/submissions",
|
|
2494
|
+
method: "POST",
|
|
2495
|
+
summary: "Create a submission package",
|
|
2496
|
+
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.",
|
|
2497
|
+
tags: ["submissions"],
|
|
2498
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2499
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2500
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2501
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2502
|
+
})).output(submissionSchema);
|
|
2503
|
+
const listSubmissionsContractV1 = base.route({
|
|
2504
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2505
|
+
method: "GET",
|
|
2506
|
+
summary: "List submission packages",
|
|
2507
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2508
|
+
tags: ["submissions"],
|
|
2509
|
+
successDescription: "The list of submission packages"
|
|
2510
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2511
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2512
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2513
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2514
|
+
})).output(z.array(submissionSchema));
|
|
2515
|
+
const getSubmissionContractV1 = base.route({
|
|
2516
|
+
path: "/v1/submissions/{submissionId}",
|
|
2517
|
+
method: "GET",
|
|
2518
|
+
summary: "Get a submission package",
|
|
2519
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2520
|
+
tags: ["submissions"],
|
|
2521
|
+
successDescription: "The submission package"
|
|
2522
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2523
|
+
const updateSubmissionContractV1 = base.route({
|
|
2524
|
+
path: "/v1/submissions/{submissionId}",
|
|
2525
|
+
method: "PUT",
|
|
2526
|
+
summary: "Update a submission package",
|
|
2527
|
+
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.",
|
|
2528
|
+
tags: ["submissions"],
|
|
2529
|
+
successDescription: "The updated submission package"
|
|
2530
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2531
|
+
submissionId: submissionIdSchema,
|
|
2532
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2533
|
+
formData: claudeSubmissionUpdateSchema
|
|
2534
|
+
}), z.object({
|
|
2535
|
+
submissionId: submissionIdSchema,
|
|
2536
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2537
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2538
|
+
})])).output(submissionSchema);
|
|
2202
2539
|
const contract = {
|
|
2203
2540
|
teams: {
|
|
2204
2541
|
list: { v1: listTeamsContractV1 },
|
|
@@ -2224,6 +2561,7 @@ const contract = {
|
|
|
2224
2561
|
environments: {
|
|
2225
2562
|
create: { v1: createEnvironmentContractV1 },
|
|
2226
2563
|
get: { v1: getEnvironmentContractV1 },
|
|
2564
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
2227
2565
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
2228
2566
|
getLogs: { v1: getLogsContractV1 },
|
|
2229
2567
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -2234,6 +2572,12 @@ const contract = {
|
|
|
2234
2572
|
update: { v1: updateEnvironmentVariableContractV1 },
|
|
2235
2573
|
delete: { v1: deleteEnvironmentVariableContractV1 }
|
|
2236
2574
|
},
|
|
2575
|
+
telemetryDestinations: {
|
|
2576
|
+
list: { v1: listTelemetryDestinationsContractV1 },
|
|
2577
|
+
create: { v1: createTelemetryDestinationContractV1 },
|
|
2578
|
+
update: { v1: updateTelemetryDestinationContractV1 },
|
|
2579
|
+
delete: { v1: deleteTelemetryDestinationContractV1 }
|
|
2580
|
+
},
|
|
2237
2581
|
projects: {
|
|
2238
2582
|
update: { v1: updateProjectContractV1 },
|
|
2239
2583
|
get: { v1: getProjectContractV1 },
|
|
@@ -2253,6 +2597,12 @@ const contract = {
|
|
|
2253
2597
|
beacon: {
|
|
2254
2598
|
create: { v1: createBeaconContractV1 },
|
|
2255
2599
|
get: { v1: getBeaconContractV1 }
|
|
2600
|
+
},
|
|
2601
|
+
submissions: {
|
|
2602
|
+
create: { v1: createSubmissionContractV1 },
|
|
2603
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2604
|
+
get: { v1: getSubmissionContractV1 },
|
|
2605
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2256
2606
|
}
|
|
2257
2607
|
};
|
|
2258
2608
|
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
@@ -2260,5 +2610,26 @@ const contractForDocs = {
|
|
|
2260
2610
|
...contract,
|
|
2261
2611
|
deployments: deploymentsForDocs
|
|
2262
2612
|
};
|
|
2613
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2614
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2615
|
+
info: {
|
|
2616
|
+
title: "Alpic API",
|
|
2617
|
+
version: "1.0.0"
|
|
2618
|
+
},
|
|
2619
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2620
|
+
security: [{ bearerAuth: [] }],
|
|
2621
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2622
|
+
type: "http",
|
|
2623
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2624
|
+
scheme: "bearer"
|
|
2625
|
+
} } },
|
|
2626
|
+
commonSchemas: {
|
|
2627
|
+
Submission: { schema: submissionSchema },
|
|
2628
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2629
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2630
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2631
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
2632
|
+
}
|
|
2633
|
+
};
|
|
2263
2634
|
//#endregion
|
|
2264
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2635
|
+
export { AI_PLATFORMS, AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, OPENAPI_DOC_OPTIONS, OTLP_PROTOCOLS, PLATFORM_LABELS, TELEMETRY_SIGNALS, buildSettingsSchema, chatgptSubmissionUpdateSchema, claudeSubmissionUpdateSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, otlpProtocolSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, telemetrySignalSchema, transportSchema, updateEnvironmentVariableSchema };
|