@alpic-ai/api 0.0.0-dev.gf80bbbb → 0.0.0-dev.gf825703
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 +5469 -46
- package/dist/index.mjs +524 -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,6 +267,25 @@ z.object({
|
|
|
256
267
|
clientSecret: z.string(),
|
|
257
268
|
clientScopes: z.array(z.string())
|
|
258
269
|
});
|
|
270
|
+
const creditEntryReasonSchema = z.enum([
|
|
271
|
+
"free_seed",
|
|
272
|
+
"paid_conversion_floor",
|
|
273
|
+
"top_up",
|
|
274
|
+
"usage",
|
|
275
|
+
"admin_adjustment"
|
|
276
|
+
]);
|
|
277
|
+
z.enum(["playground"]);
|
|
278
|
+
z.number().int().min(500);
|
|
279
|
+
const creditActivityEntrySchema = z.object({
|
|
280
|
+
reason: creditEntryReasonSchema,
|
|
281
|
+
day: z.number(),
|
|
282
|
+
amountInNanoUSD: z.number(),
|
|
283
|
+
messageCount: z.number().nullable()
|
|
284
|
+
});
|
|
285
|
+
z.object({
|
|
286
|
+
balanceInNanoUSD: z.number(),
|
|
287
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
288
|
+
});
|
|
259
289
|
const deploymentStatusSchema$1 = z.enum([
|
|
260
290
|
"ongoing",
|
|
261
291
|
"deployed",
|
|
@@ -316,7 +346,8 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
316
346
|
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
317
347
|
allowsAnonymous: z.literal(false),
|
|
318
348
|
oAuthMetadata: z.strictObject({}),
|
|
319
|
-
scope: z.string().optional()
|
|
349
|
+
scope: z.string().optional(),
|
|
350
|
+
wwwAuthenticate: z.string().optional()
|
|
320
351
|
});
|
|
321
352
|
const legacyPublicEnvironmentSchema = z.object({
|
|
322
353
|
isPublic: z.literal(true),
|
|
@@ -361,10 +392,13 @@ z.union([
|
|
|
361
392
|
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
362
393
|
]);
|
|
363
394
|
const playgroundModelSchema = z.enum([
|
|
395
|
+
"global.anthropic.claude-haiku-5-5",
|
|
364
396
|
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
365
|
-
"global.anthropic.claude-sonnet-
|
|
397
|
+
"global.anthropic.claude-sonnet-5-5",
|
|
366
398
|
"openai.gpt-5.4",
|
|
367
|
-
"openai.gpt-5.5"
|
|
399
|
+
"openai.gpt-5.5",
|
|
400
|
+
"openai.gpt-6-luna",
|
|
401
|
+
"openai.gpt-6.1-sol"
|
|
368
402
|
]);
|
|
369
403
|
const environmentDomainSchema = z.object({
|
|
370
404
|
name: z.string(),
|
|
@@ -400,7 +434,8 @@ z.object({
|
|
|
400
434
|
collectResponsePayload: z.boolean(),
|
|
401
435
|
collectErrorMessage: z.boolean(),
|
|
402
436
|
collectUserData: z.boolean(),
|
|
403
|
-
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
437
|
+
identityTraitKey: z.string().min(1).max(200).nullable(),
|
|
438
|
+
leadEventName: z.string().min(1).max(200).nullable()
|
|
404
439
|
});
|
|
405
440
|
const feedbackSchema = z.object({
|
|
406
441
|
id: z.string(),
|
|
@@ -424,7 +459,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
424
459
|
"pink",
|
|
425
460
|
"gray"
|
|
426
461
|
]);
|
|
427
|
-
intentCategoryColorSchema.options;
|
|
462
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
428
463
|
const intentCategorySchema = z.object({
|
|
429
464
|
id: z.string(),
|
|
430
465
|
createdAt: z.coerce.date(),
|
|
@@ -432,7 +467,7 @@ const intentCategorySchema = z.object({
|
|
|
432
467
|
name: z.string(),
|
|
433
468
|
color: intentCategoryColorSchema
|
|
434
469
|
});
|
|
435
|
-
z.object({
|
|
470
|
+
const intentCategorySummarySchema = z.object({
|
|
436
471
|
id: z.string(),
|
|
437
472
|
name: z.string(),
|
|
438
473
|
color: intentCategoryColorSchema,
|
|
@@ -503,12 +538,30 @@ z.object({
|
|
|
503
538
|
createdAt: z.coerce.date(),
|
|
504
539
|
updatedAt: z.coerce.date()
|
|
505
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]);
|
|
506
551
|
z.enum([
|
|
507
552
|
"INFO",
|
|
508
553
|
"WARNING",
|
|
509
554
|
"DEBUG",
|
|
510
555
|
"ERROR"
|
|
511
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");
|
|
512
565
|
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
513
566
|
const MCP_CLIENT_GROUPS = [
|
|
514
567
|
{
|
|
@@ -576,7 +629,7 @@ const MCP_CLIENT_GROUPS = [
|
|
|
576
629
|
id: "chatgpt",
|
|
577
630
|
label: "ChatGPT",
|
|
578
631
|
vendor: "openai",
|
|
579
|
-
rawNames: ["openai-mcp (ChatGPT)"]
|
|
632
|
+
rawNames: ["openai-mcp", "openai-mcp (ChatGPT)"]
|
|
580
633
|
},
|
|
581
634
|
{
|
|
582
635
|
id: "openai_responses_api",
|
|
@@ -590,12 +643,6 @@ const MCP_CLIENT_GROUPS = [
|
|
|
590
643
|
vendor: "openai",
|
|
591
644
|
rawNames: ["openai-mcp (Agent Builder)"]
|
|
592
645
|
},
|
|
593
|
-
{
|
|
594
|
-
id: "openai_other",
|
|
595
|
-
label: "OpenAI Other",
|
|
596
|
-
vendor: "openai",
|
|
597
|
-
rawNames: ["openai-mcp"]
|
|
598
|
-
},
|
|
599
646
|
{
|
|
600
647
|
id: "cursor",
|
|
601
648
|
label: "Cursor",
|
|
@@ -834,6 +881,10 @@ const clampStringField = (field) => {
|
|
|
834
881
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
835
882
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
836
883
|
};
|
|
884
|
+
const unboundedArrayField = (field) => {
|
|
885
|
+
const unbounded = z.array(field.element);
|
|
886
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
887
|
+
};
|
|
837
888
|
const toolDefinitionSchema = z.object({
|
|
838
889
|
name: z.string(),
|
|
839
890
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -846,11 +897,22 @@ const toolDefinitionSchema = z.object({
|
|
|
846
897
|
}).optional()
|
|
847
898
|
});
|
|
848
899
|
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."),
|
|
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."),
|
|
851
902
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
852
903
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
853
|
-
}).
|
|
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());
|
|
854
916
|
const screenshotEntrySchema = z.object({
|
|
855
917
|
prompt: z.string(),
|
|
856
918
|
url: z.url()
|
|
@@ -1163,9 +1225,18 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
1163
1225
|
"zh-TW"
|
|
1164
1226
|
]);
|
|
1165
1227
|
const negativeTestCaseSchema = z.object({
|
|
1166
|
-
scenario: z.string(),
|
|
1167
|
-
userPrompt: z.string()
|
|
1168
|
-
}).
|
|
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.");
|
|
1169
1240
|
const chatgptToolJustificationSchema = z.object({
|
|
1170
1241
|
toolName: z.string(),
|
|
1171
1242
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
@@ -1185,27 +1256,28 @@ chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema
|
|
|
1185
1256
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
1186
1257
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
1187
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."),
|
|
1188
|
-
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."),
|
|
1189
1260
|
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
1190
|
-
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the
|
|
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)."),
|
|
1191
1262
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
1192
|
-
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."),
|
|
1193
1264
|
companyUrl: urlField.describe("Your company's main website URL."),
|
|
1194
1265
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
1195
1266
|
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1196
|
-
termsOfServiceUrl: urlField.describe("URL to the
|
|
1197
|
-
demoRecordingUrl: urlField.describe("URL to a video demonstrating the
|
|
1198
|
-
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My
|
|
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."),
|
|
1199
1270
|
serverUrl: urlField.describe("URL of the MCP server."),
|
|
1200
1271
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
1201
1272
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1202
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."),
|
|
1203
|
-
|
|
1204
|
-
|
|
1205
|
-
|
|
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."),
|
|
1206
1278
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1207
1279
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
1208
|
-
releaseNotes: z.string().describe("Publicly displayed on the
|
|
1280
|
+
releaseNotes: z.string().describe("Publicly displayed on the plugin details page.")
|
|
1209
1281
|
});
|
|
1210
1282
|
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1211
1283
|
tagline: z.string().optional(),
|
|
@@ -1216,23 +1288,35 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
1216
1288
|
demoRecordingUrl: z.string().optional(),
|
|
1217
1289
|
serverUrl: z.string().optional(),
|
|
1218
1290
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1291
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1292
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1219
1293
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1220
1294
|
});
|
|
1221
|
-
|
|
1295
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1296
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1222
1297
|
appName: true,
|
|
1223
1298
|
developerName: true,
|
|
1224
1299
|
serverUrl: true,
|
|
1225
1300
|
tools: true,
|
|
1301
|
+
skills: true,
|
|
1226
1302
|
authentication: true
|
|
1227
1303
|
});
|
|
1228
|
-
|
|
1304
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1305
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1229
1306
|
tagline: true,
|
|
1230
1307
|
description: true,
|
|
1231
1308
|
category: true,
|
|
1232
1309
|
testCases: true,
|
|
1233
1310
|
negativeTestCases: true,
|
|
1234
1311
|
toolJustifications: true
|
|
1235
|
-
}).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
|
+
});
|
|
1236
1320
|
const claudeCategorySchema = z.enum([
|
|
1237
1321
|
"Productivity",
|
|
1238
1322
|
"Communication",
|
|
@@ -1355,7 +1439,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1355
1439
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1356
1440
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1357
1441
|
});
|
|
1358
|
-
|
|
1442
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1443
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1359
1444
|
serverUrl: true,
|
|
1360
1445
|
name: true,
|
|
1361
1446
|
slug: true,
|
|
@@ -1377,33 +1462,81 @@ const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
|
1377
1462
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1378
1463
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1379
1464
|
});
|
|
1380
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1465
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1381
1466
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1382
1467
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1383
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
|
+
});
|
|
1384
1518
|
const submissionMetaFieldsSchema = z.object({
|
|
1385
1519
|
id: z.string(),
|
|
1386
1520
|
environmentId: z.string(),
|
|
1387
1521
|
auditId: z.string().nullable(),
|
|
1522
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1388
1523
|
createdAt: z.coerce.date(),
|
|
1389
1524
|
updatedAt: z.coerce.date()
|
|
1390
1525
|
});
|
|
1391
1526
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1392
1527
|
platform: z.literal("claudeai"),
|
|
1393
|
-
formData: claudeSubmissionDraftSchema
|
|
1528
|
+
formData: claudeSubmissionDraftSchema,
|
|
1529
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1394
1530
|
});
|
|
1395
1531
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1396
1532
|
platform: z.literal("chatgpt"),
|
|
1397
|
-
formData: chatgptSubmissionDraftSchema
|
|
1533
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1534
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1398
1535
|
});
|
|
1399
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1536
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1400
1537
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1401
|
-
|
|
1402
|
-
|
|
1403
|
-
pro: 2e5,
|
|
1404
|
-
business: 2e6,
|
|
1405
|
-
enterprise: null
|
|
1406
|
-
}).free;
|
|
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;
|
|
1407
1540
|
z.literal([
|
|
1408
1541
|
100,
|
|
1409
1542
|
75,
|
|
@@ -1420,18 +1553,78 @@ const customerCreditsSchema = z.object({
|
|
|
1420
1553
|
expiresAt: z.number().nullable(),
|
|
1421
1554
|
currency: z.string()
|
|
1422
1555
|
});
|
|
1423
|
-
const customerUsageSchema = z.object({
|
|
1424
|
-
amountInCents: z.number(),
|
|
1425
|
-
currency: z.string(),
|
|
1426
|
-
periodEnd: z.number()
|
|
1427
|
-
});
|
|
1428
1556
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1429
|
-
z.object({ balanceInNanoUSD: z.number() });
|
|
1430
1557
|
z.object({
|
|
1431
1558
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1432
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1433
1559
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1434
1560
|
});
|
|
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 = [
|
|
1584
|
+
"logs",
|
|
1585
|
+
"metrics",
|
|
1586
|
+
"traces"
|
|
1587
|
+
];
|
|
1588
|
+
const telemetrySignalSchema = z.enum(TELEMETRY_SIGNALS);
|
|
1589
|
+
const OTLP_PROTOCOLS = ["http/protobuf", "http/json"];
|
|
1590
|
+
const otlpProtocolSchema = z.enum(OTLP_PROTOCOLS);
|
|
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"]);
|
|
1614
|
+
z.object({
|
|
1615
|
+
id: z.string(),
|
|
1616
|
+
signal: telemetrySignalSchema,
|
|
1617
|
+
endpoint: otlpEndpointSchema,
|
|
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
|
+
};
|
|
1435
1628
|
//#endregion
|
|
1436
1629
|
//#region src/auth-scope.ts
|
|
1437
1630
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1530,6 +1723,14 @@ const serverFieldsSchema = z.object({
|
|
|
1530
1723
|
});
|
|
1531
1724
|
//#endregion
|
|
1532
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
|
+
};
|
|
1533
1734
|
const deploymentStatusSchema = z.enum([
|
|
1534
1735
|
"ongoing",
|
|
1535
1736
|
"deployed",
|
|
@@ -1600,6 +1801,14 @@ const getEnvironmentContractV1 = base.route({
|
|
|
1600
1801
|
createdAt: z.coerce.date(),
|
|
1601
1802
|
projectId: z.string()
|
|
1602
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) }));
|
|
1603
1812
|
const domainSchema = z.object({
|
|
1604
1813
|
domain: z.string(),
|
|
1605
1814
|
status: z.enum([
|
|
@@ -1706,6 +1915,100 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1706
1915
|
isSecret: z.boolean(),
|
|
1707
1916
|
createdAt: z.coerce.date()
|
|
1708
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) }));
|
|
1709
2012
|
const listEnvironmentVariablesContractV1 = base.route({
|
|
1710
2013
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1711
2014
|
method: "GET",
|
|
@@ -1849,7 +2152,7 @@ const getLogsContractV1 = base.route({
|
|
|
1849
2152
|
"WARNING",
|
|
1850
2153
|
"DEBUG"
|
|
1851
2154
|
])).optional().describe("Filter by log level"),
|
|
1852
|
-
search:
|
|
2155
|
+
search: logSearchSchema.optional().describe("Term to search for in log content"),
|
|
1853
2156
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1854
2157
|
})).output(z.object({
|
|
1855
2158
|
logs: z.array(logEntrySchema),
|
|
@@ -1871,7 +2174,7 @@ const getLatestLogsContractV1 = base.route({
|
|
|
1871
2174
|
"WARNING",
|
|
1872
2175
|
"DEBUG"
|
|
1873
2176
|
])).optional().describe("Filter by log level"),
|
|
1874
|
-
search:
|
|
2177
|
+
search: logSearchSchema.optional().describe("Term to search for in log content")
|
|
1875
2178
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1876
2179
|
const getDeploymentLogsContractV1 = base.route({
|
|
1877
2180
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
@@ -1912,7 +2215,7 @@ const getProjectAnalyticsContractV1 = base.route({
|
|
|
1912
2215
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1913
2216
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1914
2217
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1915
|
-
}).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({
|
|
1916
2219
|
metadata: z.object({
|
|
1917
2220
|
startTimestamp: z.number(),
|
|
1918
2221
|
endTimestamp: z.number(),
|
|
@@ -1976,6 +2279,77 @@ const listFeedbacksContractV1 = base.route({
|
|
|
1976
2279
|
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
1977
2280
|
totalCount: z.number().int().nonnegative()
|
|
1978
2281
|
}));
|
|
2282
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2283
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2284
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2285
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2286
|
+
method: "GET",
|
|
2287
|
+
summary: "List intent categories",
|
|
2288
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2289
|
+
tags: ["insights"],
|
|
2290
|
+
successDescription: "The intent categories"
|
|
2291
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2292
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2293
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2294
|
+
method: "POST",
|
|
2295
|
+
summary: "Create an intent category",
|
|
2296
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2297
|
+
tags: ["insights"],
|
|
2298
|
+
successDescription: "The created intent category"
|
|
2299
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2300
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2301
|
+
name: intentCategoryNameSchema,
|
|
2302
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2303
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2304
|
+
})).output(intentCategorySchema);
|
|
2305
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2306
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2307
|
+
method: "PATCH",
|
|
2308
|
+
summary: "Update an intent category",
|
|
2309
|
+
description: "Rename or recolor an intent category",
|
|
2310
|
+
tags: ["insights"],
|
|
2311
|
+
successDescription: "The updated intent category"
|
|
2312
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2313
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2314
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2315
|
+
name: intentCategoryNameSchema.optional(),
|
|
2316
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2317
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2318
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2319
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2320
|
+
method: "DELETE",
|
|
2321
|
+
summary: "Delete an intent category",
|
|
2322
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2323
|
+
tags: ["insights"],
|
|
2324
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2325
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2326
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2327
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2328
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2329
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2330
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2331
|
+
method: "POST",
|
|
2332
|
+
summary: "Link an intent category",
|
|
2333
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2334
|
+
tags: ["insights"],
|
|
2335
|
+
successDescription: "The intents have been linked successfully"
|
|
2336
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2337
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2338
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2339
|
+
intentIds: categorizableIntentIdsSchema
|
|
2340
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2341
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2342
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2343
|
+
method: "POST",
|
|
2344
|
+
summary: "Unlink an intent category",
|
|
2345
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2346
|
+
tags: ["insights"],
|
|
2347
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2348
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2349
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2350
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2351
|
+
intentIds: categorizableIntentIdsSchema
|
|
2352
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
1979
2353
|
const listTeamsContractV1 = base.route({
|
|
1980
2354
|
path: "/v1/teams",
|
|
1981
2355
|
method: "GET",
|
|
@@ -2111,6 +2485,57 @@ const getBeaconContractV1 = base.route({
|
|
|
2111
2485
|
createdAt: z.coerce.date(),
|
|
2112
2486
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
2113
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);
|
|
2114
2539
|
const contract = {
|
|
2115
2540
|
teams: {
|
|
2116
2541
|
list: { v1: listTeamsContractV1 },
|
|
@@ -2118,6 +2543,14 @@ const contract = {
|
|
|
2118
2543
|
},
|
|
2119
2544
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2120
2545
|
intents: { list: { v1: listIntentsContractV1 } },
|
|
2546
|
+
intentCategories: {
|
|
2547
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2548
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2549
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2550
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2551
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2552
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2553
|
+
},
|
|
2121
2554
|
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
2122
2555
|
deployments: {
|
|
2123
2556
|
list: { v1: listDeploymentsContractV1 },
|
|
@@ -2128,6 +2561,7 @@ const contract = {
|
|
|
2128
2561
|
environments: {
|
|
2129
2562
|
create: { v1: createEnvironmentContractV1 },
|
|
2130
2563
|
get: { v1: getEnvironmentContractV1 },
|
|
2564
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
2131
2565
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
2132
2566
|
getLogs: { v1: getLogsContractV1 },
|
|
2133
2567
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -2138,6 +2572,12 @@ const contract = {
|
|
|
2138
2572
|
update: { v1: updateEnvironmentVariableContractV1 },
|
|
2139
2573
|
delete: { v1: deleteEnvironmentVariableContractV1 }
|
|
2140
2574
|
},
|
|
2575
|
+
telemetryDestinations: {
|
|
2576
|
+
list: { v1: listTelemetryDestinationsContractV1 },
|
|
2577
|
+
create: { v1: createTelemetryDestinationContractV1 },
|
|
2578
|
+
update: { v1: updateTelemetryDestinationContractV1 },
|
|
2579
|
+
delete: { v1: deleteTelemetryDestinationContractV1 }
|
|
2580
|
+
},
|
|
2141
2581
|
projects: {
|
|
2142
2582
|
update: { v1: updateProjectContractV1 },
|
|
2143
2583
|
get: { v1: getProjectContractV1 },
|
|
@@ -2157,6 +2597,12 @@ const contract = {
|
|
|
2157
2597
|
beacon: {
|
|
2158
2598
|
create: { v1: createBeaconContractV1 },
|
|
2159
2599
|
get: { v1: getBeaconContractV1 }
|
|
2600
|
+
},
|
|
2601
|
+
submissions: {
|
|
2602
|
+
create: { v1: createSubmissionContractV1 },
|
|
2603
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2604
|
+
get: { v1: getSubmissionContractV1 },
|
|
2605
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2160
2606
|
}
|
|
2161
2607
|
};
|
|
2162
2608
|
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
@@ -2164,5 +2610,26 @@ const contractForDocs = {
|
|
|
2164
2610
|
...contract,
|
|
2165
2611
|
deployments: deploymentsForDocs
|
|
2166
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
|
+
};
|
|
2167
2634
|
//#endregion
|
|
2168
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, 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 };
|