@alpic-ai/api 0.0.0-dev.geae8e2a → 0.0.0-dev.geaf8997
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 +6701 -97
- package/dist/index.mjs +973 -225
- package/package.json +9 -9
package/dist/index.mjs
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
import * as z$1 from "zod/v4";
|
|
3
3
|
import { oc } from "@orpc/contract";
|
|
4
4
|
import ms from "ms";
|
|
5
|
-
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.32.1_supports-color@8.1.1_zod@4.5.4/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -119,7 +119,12 @@ z$1.object({
|
|
|
119
119
|
token_type: z$1.string(),
|
|
120
120
|
expires_in: z$1.coerce.number().optional(),
|
|
121
121
|
scope: z$1.string().optional(),
|
|
122
|
-
refresh_token: z$1.string().optional()
|
|
122
|
+
refresh_token: z$1.string().optional(),
|
|
123
|
+
/**
|
|
124
|
+
* Not part of the wire format: the authorization server this value was obtained from, added by
|
|
125
|
+
* the client's `auth()` before it is stored and compared when it is read back.
|
|
126
|
+
*/
|
|
127
|
+
issuer: z$1.string().optional().catch(void 0)
|
|
123
128
|
}).strip();
|
|
124
129
|
z$1.object({
|
|
125
130
|
error: z$1.string(),
|
|
@@ -158,7 +163,12 @@ const OAuthClientInformationSchema = z$1.object({
|
|
|
158
163
|
client_id: z$1.string(),
|
|
159
164
|
client_secret: z$1.string().optional(),
|
|
160
165
|
client_id_issued_at: z$1.number().optional(),
|
|
161
|
-
client_secret_expires_at: z$1.number().optional()
|
|
166
|
+
client_secret_expires_at: z$1.number().optional(),
|
|
167
|
+
/**
|
|
168
|
+
* Not part of the wire format: the authorization server this value was obtained from, added by
|
|
169
|
+
* the client's `auth()` before it is stored and compared when it is read back.
|
|
170
|
+
*/
|
|
171
|
+
issuer: z$1.string().optional().catch(void 0)
|
|
162
172
|
}).strip();
|
|
163
173
|
OAuthClientMetadataSchema.merge(OAuthClientInformationSchema);
|
|
164
174
|
z$1.object({
|
|
@@ -169,11 +179,22 @@ z$1.object({
|
|
|
169
179
|
token: z$1.string(),
|
|
170
180
|
token_type_hint: z$1.string().optional()
|
|
171
181
|
}).strip();
|
|
172
|
-
|
|
182
|
+
//#endregion
|
|
183
|
+
//#region ../domains/dist/index.mjs
|
|
184
|
+
const AI_PLATFORMS = ["chatgpt", "claudeai"];
|
|
185
|
+
const platformSchema = z.enum(AI_PLATFORMS);
|
|
173
186
|
const PLATFORM_LABELS = {
|
|
174
187
|
chatgpt: "ChatGPT",
|
|
175
188
|
claudeai: "Claude.ai"
|
|
176
189
|
};
|
|
190
|
+
const WAF_PLATFORMS = [
|
|
191
|
+
"akamai",
|
|
192
|
+
"cato",
|
|
193
|
+
"cloudflare",
|
|
194
|
+
"fastly"
|
|
195
|
+
];
|
|
196
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
197
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
177
198
|
const auditStatusSchema = z.enum([
|
|
178
199
|
"pending",
|
|
179
200
|
"partial",
|
|
@@ -246,6 +267,25 @@ z.object({
|
|
|
246
267
|
clientSecret: z.string(),
|
|
247
268
|
clientScopes: z.array(z.string())
|
|
248
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
|
+
});
|
|
249
289
|
const deploymentStatusSchema$1 = z.enum([
|
|
250
290
|
"ongoing",
|
|
251
291
|
"deployed",
|
|
@@ -273,34 +313,52 @@ const deploymentSummarySchema = z.object({
|
|
|
273
313
|
createdAt: z.coerce.date(),
|
|
274
314
|
updatedAt: z.coerce.date()
|
|
275
315
|
});
|
|
276
|
-
/**
|
|
277
|
-
* Public environment
|
|
278
|
-
*
|
|
279
|
-
* No OAuth metadata exposed.
|
|
280
|
-
*/
|
|
316
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
281
317
|
const publicEnvironmentSchema = z.object({
|
|
318
|
+
allowsAnonymous: z.literal(true),
|
|
319
|
+
oAuthMetadata: z.strictObject({})
|
|
320
|
+
});
|
|
321
|
+
/** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
|
|
322
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
323
|
+
allowsAnonymous: z.boolean(),
|
|
324
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
325
|
+
scope: z.string().optional()
|
|
326
|
+
});
|
|
327
|
+
/** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
|
|
328
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
329
|
+
allowsAnonymous: z.boolean(),
|
|
330
|
+
oAuthMetadata: z.object({
|
|
331
|
+
externalAuthorizationServerUrl: z.url(),
|
|
332
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
333
|
+
}),
|
|
334
|
+
scope: z.string().optional()
|
|
335
|
+
});
|
|
336
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
337
|
+
const standaloneEnvironmentSchema = z.object({
|
|
338
|
+
allowsAnonymous: z.boolean(),
|
|
339
|
+
oAuthMetadata: z.object({
|
|
340
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
341
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
342
|
+
}),
|
|
343
|
+
scope: z.string().optional()
|
|
344
|
+
});
|
|
345
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
346
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
347
|
+
allowsAnonymous: z.literal(false),
|
|
348
|
+
oAuthMetadata: z.strictObject({}),
|
|
349
|
+
scope: z.string().optional(),
|
|
350
|
+
wwwAuthenticate: z.string().optional()
|
|
351
|
+
});
|
|
352
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
282
353
|
isPublic: z.literal(true),
|
|
283
354
|
oAuthMetadata: z.undefined().optional()
|
|
284
355
|
});
|
|
285
|
-
|
|
286
|
-
* Protected environment with an external resource metadata URL
|
|
287
|
-
*
|
|
288
|
-
* An external resource metadata URL is returned in the WWW-Authenticate header during the first 401 response.
|
|
289
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
290
|
-
*/
|
|
291
|
-
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
356
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
292
357
|
isPublic: z.literal(false),
|
|
293
358
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
359
|
scope: z.string().optional()
|
|
295
360
|
});
|
|
296
|
-
|
|
297
|
-
* Protected environment with an external authorization server URL
|
|
298
|
-
*
|
|
299
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
300
|
-
* An external authorization server URL is returned when requesting the endpoint.
|
|
301
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
302
|
-
*/
|
|
303
|
-
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
361
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
362
|
isPublic: z.literal(false),
|
|
305
363
|
oAuthMetadata: z.object({
|
|
306
364
|
externalAuthorizationServerUrl: z.url(),
|
|
@@ -308,13 +366,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
308
366
|
}),
|
|
309
367
|
scope: z.string().optional()
|
|
310
368
|
});
|
|
311
|
-
|
|
312
|
-
* Standalone protected environment
|
|
313
|
-
*
|
|
314
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
315
|
-
* The server itself exposes the /.well-known/oauth-authorization-server endpoint.
|
|
316
|
-
*/
|
|
317
|
-
const standaloneEnvironmentSchema = z.object({
|
|
369
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
318
370
|
isPublic: z.literal(false),
|
|
319
371
|
oAuthMetadata: z.object({
|
|
320
372
|
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
@@ -322,14 +374,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
322
374
|
}),
|
|
323
375
|
scope: z.string().optional()
|
|
324
376
|
});
|
|
325
|
-
|
|
326
|
-
* Protected environment without OAuth discovery
|
|
327
|
-
*
|
|
328
|
-
* The server enforces authentication but exposes no OAuth discovery metadata.
|
|
329
|
-
* Neither /.well-known/oauth-protected-resource nor /.well-known/oauth-authorization-server
|
|
330
|
-
* are advertised. Clients must obtain credentials out-of-band.
|
|
331
|
-
*/
|
|
332
|
-
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
377
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
378
|
isPublic: z.literal(false),
|
|
334
379
|
oAuthMetadata: z.strictObject({}),
|
|
335
380
|
scope: z.string().optional()
|
|
@@ -339,14 +384,21 @@ z.union([
|
|
|
339
384
|
externalResourceMetadataEnvironmentSchema,
|
|
340
385
|
externalAuthorizationServerEnvironmentSchema,
|
|
341
386
|
standaloneEnvironmentSchema,
|
|
342
|
-
protectedWithoutDiscoveryEnvironmentSchema
|
|
387
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
388
|
+
legacyPublicEnvironmentSchema,
|
|
389
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
390
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
391
|
+
legacyStandaloneEnvironmentSchema,
|
|
392
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
343
393
|
]);
|
|
344
|
-
const allowedPlatformSchema = platformSchema;
|
|
345
394
|
const playgroundModelSchema = z.enum([
|
|
395
|
+
"global.anthropic.claude-haiku-5-5",
|
|
346
396
|
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
347
|
-
"global.anthropic.claude-sonnet-
|
|
397
|
+
"global.anthropic.claude-sonnet-5-5",
|
|
348
398
|
"openai.gpt-5.4",
|
|
349
|
-
"openai.gpt-5.5"
|
|
399
|
+
"openai.gpt-5.5",
|
|
400
|
+
"openai.gpt-6-luna",
|
|
401
|
+
"openai.gpt-6.1-sol"
|
|
350
402
|
]);
|
|
351
403
|
const environmentDomainSchema = z.object({
|
|
352
404
|
name: z.string(),
|
|
@@ -381,14 +433,17 @@ z.object({
|
|
|
381
433
|
collectRequestPayload: z.boolean(),
|
|
382
434
|
collectResponsePayload: z.boolean(),
|
|
383
435
|
collectErrorMessage: z.boolean(),
|
|
384
|
-
collectUserData: z.boolean()
|
|
436
|
+
collectUserData: z.boolean(),
|
|
437
|
+
identityTraitKey: z.string().min(1).max(200).nullable(),
|
|
438
|
+
leadEventName: z.string().min(1).max(200).nullable()
|
|
385
439
|
});
|
|
386
|
-
z.object({
|
|
440
|
+
const feedbackSchema = z.object({
|
|
387
441
|
id: z.string(),
|
|
388
442
|
createdAt: z.coerce.date(),
|
|
389
443
|
environmentId: z.string(),
|
|
390
444
|
content: z.string(),
|
|
391
|
-
source: z.enum(["model", "user"])
|
|
445
|
+
source: z.enum(["model", "user"]),
|
|
446
|
+
clientName: z.string().nullable()
|
|
392
447
|
});
|
|
393
448
|
z.object({
|
|
394
449
|
content: z.string(),
|
|
@@ -404,7 +459,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
404
459
|
"pink",
|
|
405
460
|
"gray"
|
|
406
461
|
]);
|
|
407
|
-
intentCategoryColorSchema.options;
|
|
462
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
408
463
|
const intentCategorySchema = z.object({
|
|
409
464
|
id: z.string(),
|
|
410
465
|
createdAt: z.coerce.date(),
|
|
@@ -412,7 +467,7 @@ const intentCategorySchema = z.object({
|
|
|
412
467
|
name: z.string(),
|
|
413
468
|
color: intentCategoryColorSchema
|
|
414
469
|
});
|
|
415
|
-
z.object({
|
|
470
|
+
const intentCategorySummarySchema = z.object({
|
|
416
471
|
id: z.string(),
|
|
417
472
|
name: z.string(),
|
|
418
473
|
color: intentCategoryColorSchema,
|
|
@@ -424,6 +479,7 @@ z.object({
|
|
|
424
479
|
environmentId: z.string(),
|
|
425
480
|
toolName: z.string(),
|
|
426
481
|
message: z.string(),
|
|
482
|
+
clientName: z.string().nullable(),
|
|
427
483
|
categories: z.array(intentCategorySchema)
|
|
428
484
|
});
|
|
429
485
|
const signalCategorySchema = z.object({
|
|
@@ -482,12 +538,264 @@ z.object({
|
|
|
482
538
|
createdAt: z.coerce.date(),
|
|
483
539
|
updatedAt: z.coerce.date()
|
|
484
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]);
|
|
485
551
|
z.enum([
|
|
486
552
|
"INFO",
|
|
487
553
|
"WARNING",
|
|
488
554
|
"DEBUG",
|
|
489
555
|
"ERROR"
|
|
490
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");
|
|
565
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
566
|
+
const MCP_CLIENT_GROUPS = [
|
|
567
|
+
{
|
|
568
|
+
id: "claude_code",
|
|
569
|
+
label: "Claude Code",
|
|
570
|
+
vendor: "anthropic",
|
|
571
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
572
|
+
},
|
|
573
|
+
{
|
|
574
|
+
id: "claude",
|
|
575
|
+
label: "Claude",
|
|
576
|
+
vendor: "anthropic",
|
|
577
|
+
rawNames: [
|
|
578
|
+
"Anthropic/ClaudeAI",
|
|
579
|
+
"claude-ai",
|
|
580
|
+
"claude",
|
|
581
|
+
"Claude",
|
|
582
|
+
"claude-desktop",
|
|
583
|
+
"claude-desktop-3p"
|
|
584
|
+
]
|
|
585
|
+
},
|
|
586
|
+
{
|
|
587
|
+
id: "claude_mobile",
|
|
588
|
+
label: "Claude mobile",
|
|
589
|
+
vendor: "anthropic",
|
|
590
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
591
|
+
},
|
|
592
|
+
{
|
|
593
|
+
id: "claude_cowork",
|
|
594
|
+
label: "Claude Cowork",
|
|
595
|
+
vendor: "anthropic",
|
|
596
|
+
rawNames: ["Anthropic/Cowork"]
|
|
597
|
+
},
|
|
598
|
+
{
|
|
599
|
+
id: "claude_toolbox",
|
|
600
|
+
label: "Claude Toolbox",
|
|
601
|
+
vendor: "anthropic",
|
|
602
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
603
|
+
},
|
|
604
|
+
{
|
|
605
|
+
id: "anthropic_api",
|
|
606
|
+
label: "Anthropic API",
|
|
607
|
+
vendor: "anthropic",
|
|
608
|
+
rawNames: ["Anthropic/API"]
|
|
609
|
+
},
|
|
610
|
+
{
|
|
611
|
+
id: "anthropic_connector_refresh",
|
|
612
|
+
label: "Anthropic (connector refresh)",
|
|
613
|
+
vendor: "anthropic",
|
|
614
|
+
rawNames: ["Anthropic"]
|
|
615
|
+
},
|
|
616
|
+
{
|
|
617
|
+
id: "codex",
|
|
618
|
+
label: "Codex",
|
|
619
|
+
vendor: "openai",
|
|
620
|
+
rawNames: [
|
|
621
|
+
"codex-mcp-client",
|
|
622
|
+
"codex",
|
|
623
|
+
"Codex",
|
|
624
|
+
"codex-cli",
|
|
625
|
+
"openai-mcp (Codex)"
|
|
626
|
+
]
|
|
627
|
+
},
|
|
628
|
+
{
|
|
629
|
+
id: "chatgpt",
|
|
630
|
+
label: "ChatGPT",
|
|
631
|
+
vendor: "openai",
|
|
632
|
+
rawNames: ["openai-mcp", "openai-mcp (ChatGPT)"]
|
|
633
|
+
},
|
|
634
|
+
{
|
|
635
|
+
id: "openai_responses_api",
|
|
636
|
+
label: "OpenAI Responses API",
|
|
637
|
+
vendor: "openai",
|
|
638
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
639
|
+
},
|
|
640
|
+
{
|
|
641
|
+
id: "openai_agent_builder",
|
|
642
|
+
label: "OpenAI Agent Builder",
|
|
643
|
+
vendor: "openai",
|
|
644
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
645
|
+
},
|
|
646
|
+
{
|
|
647
|
+
id: "cursor",
|
|
648
|
+
label: "Cursor",
|
|
649
|
+
vendor: "cursor",
|
|
650
|
+
rawNames: [
|
|
651
|
+
"cursor-vscode",
|
|
652
|
+
"Cursor",
|
|
653
|
+
"cursor"
|
|
654
|
+
]
|
|
655
|
+
},
|
|
656
|
+
{
|
|
657
|
+
id: "cline",
|
|
658
|
+
label: "Cline",
|
|
659
|
+
vendor: "cline",
|
|
660
|
+
rawNames: [
|
|
661
|
+
"Cline",
|
|
662
|
+
"cline",
|
|
663
|
+
"@cline/core"
|
|
664
|
+
]
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
id: "github_copilot",
|
|
668
|
+
label: "GitHub Copilot",
|
|
669
|
+
vendor: "githubCopilot",
|
|
670
|
+
rawNames: [
|
|
671
|
+
"Copilot",
|
|
672
|
+
"github-copilot-developer",
|
|
673
|
+
"Copilot MCP Gateway",
|
|
674
|
+
"Xcode/copilot-xcode"
|
|
675
|
+
]
|
|
676
|
+
},
|
|
677
|
+
{
|
|
678
|
+
id: "gemini_cli",
|
|
679
|
+
label: "Gemini CLI",
|
|
680
|
+
vendor: "google",
|
|
681
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
id: "antigravity",
|
|
685
|
+
label: "Antigravity",
|
|
686
|
+
vendor: "google",
|
|
687
|
+
rawNames: ["antigravity-client"]
|
|
688
|
+
},
|
|
689
|
+
{
|
|
690
|
+
id: "gemini",
|
|
691
|
+
label: "Gemini",
|
|
692
|
+
vendor: "google",
|
|
693
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
694
|
+
},
|
|
695
|
+
{
|
|
696
|
+
id: "windsurf",
|
|
697
|
+
label: "Windsurf",
|
|
698
|
+
vendor: "windsurf",
|
|
699
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "mistral",
|
|
703
|
+
label: "Mistral / Le Chat",
|
|
704
|
+
vendor: "mistral",
|
|
705
|
+
rawNames: ["Mistral"],
|
|
706
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
707
|
+
},
|
|
708
|
+
{
|
|
709
|
+
id: "n8n",
|
|
710
|
+
label: "n8n",
|
|
711
|
+
vendor: "n8n",
|
|
712
|
+
rawNames: [
|
|
713
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
714
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
715
|
+
"n8n"
|
|
716
|
+
]
|
|
717
|
+
},
|
|
718
|
+
{
|
|
719
|
+
id: "alpic_playground",
|
|
720
|
+
label: "Alpic Playground",
|
|
721
|
+
vendor: "alpic",
|
|
722
|
+
rawNames: ["alpic-playground", "playground"]
|
|
723
|
+
},
|
|
724
|
+
{
|
|
725
|
+
id: "opencode",
|
|
726
|
+
label: "opencode",
|
|
727
|
+
vendor: "opencode",
|
|
728
|
+
rawNames: ["opencode"]
|
|
729
|
+
},
|
|
730
|
+
{
|
|
731
|
+
id: "zed",
|
|
732
|
+
label: "Zed",
|
|
733
|
+
vendor: "zed",
|
|
734
|
+
rawNames: ["Zed", "zed"]
|
|
735
|
+
},
|
|
736
|
+
{
|
|
737
|
+
id: "zapier",
|
|
738
|
+
label: "Zapier",
|
|
739
|
+
vendor: "zapier",
|
|
740
|
+
rawNames: ["Zapier", "zapier"]
|
|
741
|
+
},
|
|
742
|
+
{
|
|
743
|
+
id: "make",
|
|
744
|
+
label: "Make",
|
|
745
|
+
vendor: "make",
|
|
746
|
+
rawNames: ["Make", "make"]
|
|
747
|
+
},
|
|
748
|
+
{
|
|
749
|
+
id: "librechat",
|
|
750
|
+
label: "LibreChat",
|
|
751
|
+
vendor: "mcp",
|
|
752
|
+
rawNames: ["LibreChat", "librechat"]
|
|
753
|
+
},
|
|
754
|
+
{
|
|
755
|
+
id: "jan",
|
|
756
|
+
label: "Jan",
|
|
757
|
+
vendor: "mcp",
|
|
758
|
+
rawNames: ["Jan", "jan"]
|
|
759
|
+
},
|
|
760
|
+
{
|
|
761
|
+
id: "goose",
|
|
762
|
+
label: "goose",
|
|
763
|
+
vendor: "mcp",
|
|
764
|
+
rawNames: ["goose", "Goose"]
|
|
765
|
+
},
|
|
766
|
+
{
|
|
767
|
+
id: "mcphost",
|
|
768
|
+
label: "mcphost",
|
|
769
|
+
vendor: "mcp",
|
|
770
|
+
rawNames: ["mcphost"]
|
|
771
|
+
},
|
|
772
|
+
{
|
|
773
|
+
id: "mcporter",
|
|
774
|
+
label: "mcporter",
|
|
775
|
+
vendor: "mcp",
|
|
776
|
+
rawNames: ["mcporter"]
|
|
777
|
+
},
|
|
778
|
+
{
|
|
779
|
+
id: "rmcp",
|
|
780
|
+
label: "rmcp",
|
|
781
|
+
vendor: "mcp",
|
|
782
|
+
rawNames: ["rmcp"]
|
|
783
|
+
},
|
|
784
|
+
{
|
|
785
|
+
id: "unnamed_client",
|
|
786
|
+
label: "Unnamed client",
|
|
787
|
+
vendor: "mcp",
|
|
788
|
+
rawNames: [
|
|
789
|
+
"mcp",
|
|
790
|
+
"unknown",
|
|
791
|
+
""
|
|
792
|
+
]
|
|
793
|
+
}
|
|
794
|
+
];
|
|
795
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
796
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
797
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
798
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
491
799
|
const runtimeSchema = z.enum([
|
|
492
800
|
"python3.13",
|
|
493
801
|
"python3.14",
|
|
@@ -565,15 +873,7 @@ z.object({
|
|
|
565
873
|
serverFields: serverFieldsSchema$1,
|
|
566
874
|
source: z.enum(["registry", "defaults"])
|
|
567
875
|
});
|
|
568
|
-
/**
|
|
569
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
570
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
571
|
-
*
|
|
572
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
573
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
574
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
575
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
576
|
-
*/
|
|
876
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
577
877
|
const clampStringField = (field) => {
|
|
578
878
|
const max = field.maxLength;
|
|
579
879
|
if (max === null) return field;
|
|
@@ -581,6 +881,10 @@ const clampStringField = (field) => {
|
|
|
581
881
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
582
882
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
583
883
|
};
|
|
884
|
+
const unboundedArrayField = (field) => {
|
|
885
|
+
const unbounded = z.array(field.element);
|
|
886
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
887
|
+
};
|
|
584
888
|
const toolDefinitionSchema = z.object({
|
|
585
889
|
name: z.string(),
|
|
586
890
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -593,11 +897,22 @@ const toolDefinitionSchema = z.object({
|
|
|
593
897
|
}).optional()
|
|
594
898
|
});
|
|
595
899
|
const positiveTestCaseSchema = z.object({
|
|
596
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
597
|
-
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."),
|
|
598
902
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
599
903
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
600
|
-
}).
|
|
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());
|
|
601
916
|
const screenshotEntrySchema = z.object({
|
|
602
917
|
prompt: z.string(),
|
|
603
918
|
url: z.url()
|
|
@@ -910,20 +1225,25 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
910
1225
|
"zh-TW"
|
|
911
1226
|
]);
|
|
912
1227
|
const negativeTestCaseSchema = z.object({
|
|
913
|
-
scenario: z.string(),
|
|
914
|
-
userPrompt: z.string()
|
|
915
|
-
}).
|
|
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.");
|
|
916
1240
|
const chatgptToolJustificationSchema = z.object({
|
|
917
1241
|
toolName: z.string(),
|
|
918
1242
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
919
1243
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
920
1244
|
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
921
1245
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
922
|
-
/**
|
|
923
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
924
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
925
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
926
|
-
*/
|
|
1246
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
927
1247
|
const chatgptTaglineSchema = z.string().max(30);
|
|
928
1248
|
const chatgptDescriptionSchema = z.string();
|
|
929
1249
|
const chatgptTranslationSchema = z.object({
|
|
@@ -932,34 +1252,32 @@ const chatgptTranslationSchema = z.object({
|
|
|
932
1252
|
description: chatgptDescriptionSchema
|
|
933
1253
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
934
1254
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
935
|
-
/**
|
|
936
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
937
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
938
|
-
*/
|
|
1255
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
939
1256
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
940
1257
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
941
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."),
|
|
942
|
-
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."),
|
|
943
1260
|
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
944
|
-
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)."),
|
|
945
1262
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
946
|
-
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."),
|
|
947
1264
|
companyUrl: urlField.describe("Your company's main website URL."),
|
|
948
1265
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
949
1266
|
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
950
|
-
termsOfServiceUrl: urlField.describe("URL to the
|
|
951
|
-
demoRecordingUrl: urlField.describe("URL to a video demonstrating the
|
|
952
|
-
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."),
|
|
953
1270
|
serverUrl: urlField.describe("URL of the MCP server."),
|
|
954
1271
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
955
1272
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
956
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."),
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
|
|
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."),
|
|
960
1278
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
961
1279
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
962
|
-
releaseNotes: z.string().describe("Publicly displayed on the
|
|
1280
|
+
releaseNotes: z.string().describe("Publicly displayed on the plugin details page.")
|
|
963
1281
|
});
|
|
964
1282
|
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
965
1283
|
tagline: z.string().optional(),
|
|
@@ -970,23 +1288,35 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
970
1288
|
demoRecordingUrl: z.string().optional(),
|
|
971
1289
|
serverUrl: z.string().optional(),
|
|
972
1290
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1291
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1292
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
973
1293
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
974
1294
|
});
|
|
975
|
-
|
|
1295
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1296
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
976
1297
|
appName: true,
|
|
977
1298
|
developerName: true,
|
|
978
1299
|
serverUrl: true,
|
|
979
1300
|
tools: true,
|
|
1301
|
+
skills: true,
|
|
980
1302
|
authentication: true
|
|
981
1303
|
});
|
|
982
|
-
|
|
1304
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1305
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
983
1306
|
tagline: true,
|
|
984
1307
|
description: true,
|
|
985
1308
|
category: true,
|
|
986
1309
|
testCases: true,
|
|
987
1310
|
negativeTestCases: true,
|
|
988
1311
|
toolJustifications: true
|
|
989
|
-
}).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
|
+
});
|
|
990
1320
|
const claudeCategorySchema = z.enum([
|
|
991
1321
|
"Productivity",
|
|
992
1322
|
"Communication",
|
|
@@ -1032,11 +1362,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1032
1362
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1033
1363
|
"Public documentation for this connector will be live by the publish date."
|
|
1034
1364
|
]);
|
|
1035
|
-
/**
|
|
1036
|
-
* Field order mirrors the claude.ai directory submission wizard
|
|
1037
|
-
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1038
|
-
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1039
|
-
*/
|
|
1365
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
1040
1366
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1041
1367
|
serverUrl: z.url().describe(`The full https:// URL where your MCP server is hosted and reachable. In the claude.ai wizard this is read live
|
|
1042
1368
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1113,7 +1439,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1113
1439
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1114
1440
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1115
1441
|
});
|
|
1116
|
-
|
|
1442
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1443
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1117
1444
|
serverUrl: true,
|
|
1118
1445
|
name: true,
|
|
1119
1446
|
slug: true,
|
|
@@ -1128,39 +1455,93 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1128
1455
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1129
1456
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1130
1457
|
});
|
|
1131
|
-
/**
|
|
1132
|
-
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1133
|
-
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1134
|
-
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1135
|
-
* colocated with the Claude contract.
|
|
1136
|
-
*/
|
|
1458
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1137
1459
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1138
1460
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1139
1461
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1140
1462
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1141
1463
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1142
1464
|
});
|
|
1143
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1465
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1144
1466
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1145
1467
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1146
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
|
+
});
|
|
1147
1518
|
const submissionMetaFieldsSchema = z.object({
|
|
1148
1519
|
id: z.string(),
|
|
1149
1520
|
environmentId: z.string(),
|
|
1150
1521
|
auditId: z.string().nullable(),
|
|
1522
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1151
1523
|
createdAt: z.coerce.date(),
|
|
1152
1524
|
updatedAt: z.coerce.date()
|
|
1153
1525
|
});
|
|
1154
1526
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1155
1527
|
platform: z.literal("claudeai"),
|
|
1156
|
-
formData: claudeSubmissionDraftSchema
|
|
1528
|
+
formData: claudeSubmissionDraftSchema,
|
|
1529
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1157
1530
|
});
|
|
1158
1531
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1159
1532
|
platform: z.literal("chatgpt"),
|
|
1160
|
-
formData: chatgptSubmissionDraftSchema
|
|
1533
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1534
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1161
1535
|
});
|
|
1162
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1536
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1163
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;
|
|
1540
|
+
z.literal([
|
|
1541
|
+
100,
|
|
1542
|
+
75,
|
|
1543
|
+
50
|
|
1544
|
+
]);
|
|
1164
1545
|
const subscriptionPlanSchema = z.enum([
|
|
1165
1546
|
"pro",
|
|
1166
1547
|
"business",
|
|
@@ -1172,17 +1553,78 @@ const customerCreditsSchema = z.object({
|
|
|
1172
1553
|
expiresAt: z.number().nullable(),
|
|
1173
1554
|
currency: z.string()
|
|
1174
1555
|
});
|
|
1175
|
-
const customerUsageSchema = z.object({
|
|
1176
|
-
amountInCents: z.number(),
|
|
1177
|
-
currency: z.string(),
|
|
1178
|
-
periodEnd: z.number()
|
|
1179
|
-
});
|
|
1180
1556
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1181
1557
|
z.object({
|
|
1182
1558
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1183
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1184
1559
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1185
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
|
+
};
|
|
1186
1628
|
//#endregion
|
|
1187
1629
|
//#region src/auth-scope.ts
|
|
1188
1630
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1225,7 +1667,10 @@ const RESERVED_KEYS = [
|
|
|
1225
1667
|
"BUILD_ARG_START_COMMAND",
|
|
1226
1668
|
"ALPIC_HOST",
|
|
1227
1669
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1228
|
-
"ALPIC_INTENT_META_KEY"
|
|
1670
|
+
"ALPIC_INTENT_META_KEY",
|
|
1671
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1672
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1673
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1229
1674
|
];
|
|
1230
1675
|
const environmentVariableSchema = z.object({
|
|
1231
1676
|
key: z.string().min(2, "Key must be at least 2 characters").regex(/^[a-zA-Z]([a-zA-Z0-9_])+$/, "Key must start with a letter and contain only letters, numbers, and underscores").refine((key) => !RESERVED_KEYS.includes(key), "This key is reserved and cannot be used as an environment variable key"),
|
|
@@ -1278,6 +1723,14 @@ const serverFieldsSchema = z.object({
|
|
|
1278
1723
|
});
|
|
1279
1724
|
//#endregion
|
|
1280
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
|
+
};
|
|
1281
1734
|
const deploymentStatusSchema = z.enum([
|
|
1282
1735
|
"ongoing",
|
|
1283
1736
|
"deployed",
|
|
@@ -1306,21 +1759,20 @@ const deploymentSchema = z.object({
|
|
|
1306
1759
|
isCurrent: z.boolean(),
|
|
1307
1760
|
deploymentPageUrl: z.url().nullable()
|
|
1308
1761
|
});
|
|
1309
|
-
const
|
|
1762
|
+
const isValidTimeInput = (value) => {
|
|
1310
1763
|
if (ms(value) !== void 0) return true;
|
|
1311
1764
|
return !Number.isNaN(new Date(value).getTime());
|
|
1312
1765
|
};
|
|
1313
|
-
const
|
|
1766
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1767
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1768
|
+
const createEnvironmentContractV1 = base.route({
|
|
1314
1769
|
path: "/v1/environments",
|
|
1315
1770
|
method: "POST",
|
|
1316
1771
|
summary: "Create an environment",
|
|
1317
1772
|
description: "Create an environment for a project",
|
|
1318
1773
|
tags: ["environments"],
|
|
1319
1774
|
successDescription: "The environment has been created successfully"
|
|
1320
|
-
}).errors({
|
|
1321
|
-
NOT_FOUND: {},
|
|
1322
|
-
BAD_REQUEST: {}
|
|
1323
|
-
}).input(z.object({
|
|
1775
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1324
1776
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1325
1777
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1326
1778
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1333,7 +1785,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1333
1785
|
createdAt: z.coerce.date(),
|
|
1334
1786
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1335
1787
|
}));
|
|
1336
|
-
const getEnvironmentContractV1 =
|
|
1788
|
+
const getEnvironmentContractV1 = base.route({
|
|
1337
1789
|
path: "/v1/environments/{environmentId}",
|
|
1338
1790
|
method: "GET",
|
|
1339
1791
|
summary: "Get an environment",
|
|
@@ -1349,6 +1801,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1349
1801
|
createdAt: z.coerce.date(),
|
|
1350
1802
|
projectId: z.string()
|
|
1351
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) }));
|
|
1352
1812
|
const domainSchema = z.object({
|
|
1353
1813
|
domain: z.string(),
|
|
1354
1814
|
status: z.enum([
|
|
@@ -1390,7 +1850,7 @@ const projectOutputSchema = z.object({
|
|
|
1390
1850
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1391
1851
|
environments: z.array(environmentSchema)
|
|
1392
1852
|
});
|
|
1393
|
-
const getProjectContractV1 =
|
|
1853
|
+
const getProjectContractV1 = base.route({
|
|
1394
1854
|
path: "/v1/projects/{projectId}",
|
|
1395
1855
|
method: "GET",
|
|
1396
1856
|
summary: "Get a project",
|
|
@@ -1398,18 +1858,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1398
1858
|
tags: ["projects"],
|
|
1399
1859
|
successDescription: "The project details"
|
|
1400
1860
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1401
|
-
const listProjectsContractV1 =
|
|
1861
|
+
const listProjectsContractV1 = base.route({
|
|
1402
1862
|
path: "/v1/projects",
|
|
1403
1863
|
method: "GET",
|
|
1404
1864
|
summary: "List projects",
|
|
1405
1865
|
description: "List all projects for a team",
|
|
1406
1866
|
tags: ["projects"],
|
|
1407
1867
|
successDescription: "The list of projects"
|
|
1408
|
-
}).errors({
|
|
1409
|
-
|
|
1410
|
-
BAD_REQUEST: {}
|
|
1411
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1412
|
-
const createProjectContractV1 = oc.route({
|
|
1868
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1869
|
+
const createProjectContractV1 = base.route({
|
|
1413
1870
|
path: "/v1/projects",
|
|
1414
1871
|
method: "POST",
|
|
1415
1872
|
summary: "Create a project",
|
|
@@ -1418,7 +1875,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1418
1875
|
successDescription: "The project has been created successfully"
|
|
1419
1876
|
}).errors({
|
|
1420
1877
|
NOT_FOUND: {},
|
|
1421
|
-
BAD_REQUEST: {},
|
|
1422
1878
|
FORBIDDEN: {}
|
|
1423
1879
|
}).input(z.object({
|
|
1424
1880
|
teamId: z.string().optional(),
|
|
@@ -1459,7 +1915,101 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1459
1915
|
isSecret: z.boolean(),
|
|
1460
1916
|
createdAt: z.coerce.date()
|
|
1461
1917
|
});
|
|
1462
|
-
const
|
|
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) }));
|
|
2012
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1463
2013
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1464
2014
|
method: "GET",
|
|
1465
2015
|
summary: "List environment variables",
|
|
@@ -1467,48 +2017,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1467
2017
|
tags: ["environments"],
|
|
1468
2018
|
successDescription: "The list of environment variables"
|
|
1469
2019
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1470
|
-
const createEnvironmentVariablesContractV1 =
|
|
2020
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1471
2021
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1472
2022
|
method: "POST",
|
|
1473
2023
|
summary: "Add environment variables",
|
|
1474
2024
|
description: "Add one or more environment variables to an environment",
|
|
1475
2025
|
tags: ["environments"],
|
|
1476
2026
|
successDescription: "The environment variables have been added successfully"
|
|
1477
|
-
}).errors({
|
|
1478
|
-
NOT_FOUND: {},
|
|
1479
|
-
BAD_REQUEST: {}
|
|
1480
|
-
}).input(z.object({
|
|
2027
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1481
2028
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1482
2029
|
environmentVariables: environmentVariablesSchema
|
|
1483
2030
|
})).output(z.object({ success: z.literal(true) }));
|
|
1484
|
-
const updateEnvironmentVariableContractV1 =
|
|
2031
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1485
2032
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1486
2033
|
method: "PATCH",
|
|
1487
2034
|
summary: "Update an environment variable",
|
|
1488
2035
|
description: "Update an environment variable by ID",
|
|
1489
2036
|
tags: ["environments"],
|
|
1490
2037
|
successDescription: "The environment variable has been updated successfully"
|
|
1491
|
-
}).errors({
|
|
1492
|
-
NOT_FOUND: {},
|
|
1493
|
-
BAD_REQUEST: {}
|
|
1494
|
-
}).input(z.object({
|
|
2038
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1495
2039
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1496
2040
|
key: environmentVariableSchema.shape.key,
|
|
1497
2041
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1498
2042
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1499
2043
|
})).output(z.object({ success: z.literal(true) }));
|
|
1500
|
-
const deleteEnvironmentVariableContractV1 =
|
|
2044
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1501
2045
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1502
2046
|
method: "DELETE",
|
|
1503
2047
|
summary: "Delete an environment variable",
|
|
1504
2048
|
description: "Delete an environment variable by ID",
|
|
1505
2049
|
tags: ["environments"],
|
|
1506
2050
|
successDescription: "The environment variable has been deleted successfully"
|
|
1507
|
-
}).errors({
|
|
1508
|
-
|
|
1509
|
-
BAD_REQUEST: {}
|
|
1510
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1511
|
-
const deleteProjectContractV1 = oc.route({
|
|
2051
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
2052
|
+
const deleteProjectContractV1 = base.route({
|
|
1512
2053
|
path: "/v1/projects/{projectId}",
|
|
1513
2054
|
method: "DELETE",
|
|
1514
2055
|
summary: "Delete a project",
|
|
@@ -1516,7 +2057,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1516
2057
|
tags: ["projects"],
|
|
1517
2058
|
successDescription: "The project has been deleted successfully"
|
|
1518
2059
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1519
|
-
const updateProjectContractV1 =
|
|
2060
|
+
const updateProjectContractV1 = base.route({
|
|
1520
2061
|
path: "/v1/projects/{projectId}",
|
|
1521
2062
|
method: "PATCH",
|
|
1522
2063
|
summary: "Update a project",
|
|
@@ -1525,14 +2066,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1525
2066
|
successDescription: "The project has been updated successfully"
|
|
1526
2067
|
}).errors({
|
|
1527
2068
|
NOT_FOUND: {},
|
|
1528
|
-
BAD_REQUEST: {},
|
|
1529
2069
|
FORBIDDEN: {}
|
|
1530
2070
|
}).input(z.object({
|
|
1531
2071
|
projectId: z.string().describe("The ID of the project"),
|
|
1532
2072
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1533
2073
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1534
2074
|
})).output(projectOutputSchema);
|
|
1535
|
-
const deployEnvironmentContractV1 =
|
|
2075
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1536
2076
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1537
2077
|
method: "POST",
|
|
1538
2078
|
summary: "Deploy an environment",
|
|
@@ -1541,28 +2081,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1541
2081
|
successDescription: "The environment has been deployed successfully"
|
|
1542
2082
|
}).errors({
|
|
1543
2083
|
NOT_FOUND: {},
|
|
1544
|
-
|
|
2084
|
+
CONFLICT: {}
|
|
1545
2085
|
}).input(z.object({
|
|
1546
2086
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1547
2087
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1548
2088
|
settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
|
|
1549
2089
|
})).output(deploymentSchema);
|
|
1550
|
-
const uploadDeploymentArtifactContractV1 =
|
|
2090
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1551
2091
|
path: "/v1/deployments/upload",
|
|
1552
2092
|
method: "POST",
|
|
1553
2093
|
summary: "Upload deployment artifacts",
|
|
1554
2094
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1555
2095
|
tags: ["deployments"],
|
|
1556
2096
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1557
|
-
}).errors({
|
|
1558
|
-
NOT_FOUND: {},
|
|
1559
|
-
BAD_REQUEST: {}
|
|
1560
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
2097
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1561
2098
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1562
2099
|
token: z.string().describe("Token to identify the source archive"),
|
|
1563
2100
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1564
2101
|
}));
|
|
1565
|
-
const listDeploymentsContractV1 =
|
|
2102
|
+
const listDeploymentsContractV1 = base.route({
|
|
1566
2103
|
path: "/v1/projects/{projectId}/deployments",
|
|
1567
2104
|
method: "GET",
|
|
1568
2105
|
summary: "List project deployments",
|
|
@@ -1574,7 +2111,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1574
2111
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1575
2112
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1576
2113
|
})).output(z.array(deploymentSchema));
|
|
1577
|
-
const getDeploymentContractV1 =
|
|
2114
|
+
const getDeploymentContractV1 = base.route({
|
|
1578
2115
|
path: "/v1/deployments/{deploymentId}",
|
|
1579
2116
|
method: "GET",
|
|
1580
2117
|
summary: "Get a deployment",
|
|
@@ -1582,20 +2119,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1582
2119
|
tags: ["deployments"],
|
|
1583
2120
|
successDescription: "The deployment details"
|
|
1584
2121
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1585
|
-
const
|
|
2122
|
+
const logEntrySchema = z.object({
|
|
2123
|
+
timestamp: z.coerce.date(),
|
|
2124
|
+
type: z.enum([
|
|
2125
|
+
"START",
|
|
2126
|
+
"END",
|
|
2127
|
+
"INFO",
|
|
2128
|
+
"ERROR",
|
|
2129
|
+
"WARNING",
|
|
2130
|
+
"DEBUG"
|
|
2131
|
+
]),
|
|
2132
|
+
requestId: z.string(),
|
|
2133
|
+
content: z.string().optional(),
|
|
2134
|
+
method: z.string().optional(),
|
|
2135
|
+
durationInMs: z.number().optional()
|
|
2136
|
+
});
|
|
2137
|
+
const getLogsContractV1 = base.route({
|
|
1586
2138
|
path: "/v1/environments/{environmentId}/logs",
|
|
1587
2139
|
method: "GET",
|
|
1588
2140
|
summary: "Get logs",
|
|
1589
2141
|
description: "Get logs for an environment",
|
|
1590
2142
|
tags: ["environments"],
|
|
1591
2143
|
successDescription: "The logs"
|
|
1592
|
-
}).errors({
|
|
1593
|
-
NOT_FOUND: {},
|
|
1594
|
-
BAD_REQUEST: {}
|
|
1595
|
-
}).input(z.object({
|
|
2144
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1596
2145
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1597
|
-
since:
|
|
1598
|
-
until:
|
|
2146
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2147
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1599
2148
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1600
2149
|
level: z.array(z.enum([
|
|
1601
2150
|
"INFO",
|
|
@@ -1603,37 +2152,20 @@ const getLogsContractV1 = oc.route({
|
|
|
1603
2152
|
"WARNING",
|
|
1604
2153
|
"DEBUG"
|
|
1605
2154
|
])).optional().describe("Filter by log level"),
|
|
1606
|
-
search:
|
|
2155
|
+
search: logSearchSchema.optional().describe("Term to search for in log content"),
|
|
1607
2156
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1608
2157
|
})).output(z.object({
|
|
1609
|
-
logs: z.array(
|
|
1610
|
-
timestamp: z.coerce.date(),
|
|
1611
|
-
type: z.enum([
|
|
1612
|
-
"START",
|
|
1613
|
-
"END",
|
|
1614
|
-
"INFO",
|
|
1615
|
-
"ERROR",
|
|
1616
|
-
"WARNING",
|
|
1617
|
-
"DEBUG"
|
|
1618
|
-
]),
|
|
1619
|
-
requestId: z.string(),
|
|
1620
|
-
content: z.string().optional(),
|
|
1621
|
-
method: z.string().optional(),
|
|
1622
|
-
durationInMs: z.number().optional()
|
|
1623
|
-
})),
|
|
2158
|
+
logs: z.array(logEntrySchema),
|
|
1624
2159
|
nextToken: z.string().nullable()
|
|
1625
2160
|
}));
|
|
1626
|
-
const getLatestLogsContractV1 =
|
|
2161
|
+
const getLatestLogsContractV1 = base.route({
|
|
1627
2162
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1628
2163
|
method: "GET",
|
|
1629
2164
|
summary: "Get latest logs",
|
|
1630
2165
|
description: "Get the N most recent logs for an environment",
|
|
1631
2166
|
tags: ["environments"],
|
|
1632
2167
|
successDescription: "The latest logs"
|
|
1633
|
-
}).errors({
|
|
1634
|
-
NOT_FOUND: {},
|
|
1635
|
-
BAD_REQUEST: {}
|
|
1636
|
-
}).input(z.object({
|
|
2168
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1637
2169
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1638
2170
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1639
2171
|
level: z.array(z.enum([
|
|
@@ -1642,23 +2174,9 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1642
2174
|
"WARNING",
|
|
1643
2175
|
"DEBUG"
|
|
1644
2176
|
])).optional().describe("Filter by log level"),
|
|
1645
|
-
search:
|
|
1646
|
-
})).output(z.object({ logs: z.array(
|
|
1647
|
-
|
|
1648
|
-
type: z.enum([
|
|
1649
|
-
"START",
|
|
1650
|
-
"END",
|
|
1651
|
-
"INFO",
|
|
1652
|
-
"ERROR",
|
|
1653
|
-
"WARNING",
|
|
1654
|
-
"DEBUG"
|
|
1655
|
-
]),
|
|
1656
|
-
requestId: z.string(),
|
|
1657
|
-
content: z.string().optional(),
|
|
1658
|
-
method: z.string().optional(),
|
|
1659
|
-
durationInMs: z.number().optional()
|
|
1660
|
-
})) }));
|
|
1661
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
2177
|
+
search: logSearchSchema.optional().describe("Term to search for in log content")
|
|
2178
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
2179
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1662
2180
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1663
2181
|
method: "GET",
|
|
1664
2182
|
summary: "Get deployment logs",
|
|
@@ -1685,22 +2203,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1685
2203
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1686
2204
|
task_count: z.array(analyticsDataPointSchema)
|
|
1687
2205
|
});
|
|
1688
|
-
const getProjectAnalyticsContractV1 =
|
|
2206
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1689
2207
|
path: "/v1/analytics/{projectId}",
|
|
1690
2208
|
method: "GET",
|
|
1691
2209
|
summary: "Get project analytics",
|
|
1692
2210
|
description: "Get analytics data for a project over a time range",
|
|
1693
2211
|
tags: ["analytics"],
|
|
1694
2212
|
successDescription: "The project analytics data"
|
|
1695
|
-
}).errors({
|
|
1696
|
-
NOT_FOUND: {},
|
|
1697
|
-
BAD_REQUEST: {}
|
|
1698
|
-
}).input(z.object({
|
|
2213
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1699
2214
|
projectId: z.string().describe("The ID of the project"),
|
|
1700
2215
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1701
2216
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1702
2217
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1703
|
-
}).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({
|
|
1704
2219
|
metadata: z.object({
|
|
1705
2220
|
startTimestamp: z.number(),
|
|
1706
2221
|
endTimestamp: z.number(),
|
|
@@ -1710,7 +2225,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1710
2225
|
}),
|
|
1711
2226
|
timeSeries: analyticsTimeSeriesSchema
|
|
1712
2227
|
}));
|
|
1713
|
-
const
|
|
2228
|
+
const paginatedInsightsInputShape = {
|
|
2229
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2230
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2231
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2232
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2233
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2234
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2235
|
+
};
|
|
2236
|
+
const listIntentsContractV1 = base.route({
|
|
2237
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2238
|
+
method: "GET",
|
|
2239
|
+
summary: "List intents",
|
|
2240
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2241
|
+
tags: ["insights"],
|
|
2242
|
+
successDescription: "The grouped user intents"
|
|
2243
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2244
|
+
...paginatedInsightsInputShape,
|
|
2245
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2246
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2247
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2248
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2249
|
+
})).output(z.object({
|
|
2250
|
+
intents: z.array(z.object({
|
|
2251
|
+
id: z.string(),
|
|
2252
|
+
intentIds: z.array(z.string()).min(1),
|
|
2253
|
+
environmentId: z.string(),
|
|
2254
|
+
message: z.string(),
|
|
2255
|
+
toolName: z.string(),
|
|
2256
|
+
createdAt: z.coerce.date(),
|
|
2257
|
+
occurrenceCount: z.number().int().positive(),
|
|
2258
|
+
clientName: z.string().nullable(),
|
|
2259
|
+
clientId: z.string().nullable(),
|
|
2260
|
+
categories: z.array(z.object({
|
|
2261
|
+
id: z.string(),
|
|
2262
|
+
name: z.string(),
|
|
2263
|
+
color: intentCategoryColorSchema
|
|
2264
|
+
}))
|
|
2265
|
+
})),
|
|
2266
|
+
totalCount: z.number().int().nonnegative()
|
|
2267
|
+
}));
|
|
2268
|
+
const listFeedbacksContractV1 = base.route({
|
|
2269
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2270
|
+
method: "GET",
|
|
2271
|
+
summary: "List feedbacks",
|
|
2272
|
+
description: "List user feedback for an environment over a time range",
|
|
2273
|
+
tags: ["insights"],
|
|
2274
|
+
successDescription: "The user feedback"
|
|
2275
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2276
|
+
...paginatedInsightsInputShape,
|
|
2277
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2278
|
+
})).output(z.object({
|
|
2279
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2280
|
+
totalCount: z.number().int().nonnegative()
|
|
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) }));
|
|
2353
|
+
const listTeamsContractV1 = base.route({
|
|
1714
2354
|
path: "/v1/teams",
|
|
1715
2355
|
method: "GET",
|
|
1716
2356
|
summary: "List teams",
|
|
@@ -1723,7 +2363,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1723
2363
|
createdAt: z.coerce.date(),
|
|
1724
2364
|
hasStripeAccount: z.boolean()
|
|
1725
2365
|
})));
|
|
1726
|
-
const
|
|
2366
|
+
const getTeamUsageContractV1 = base.route({
|
|
2367
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2368
|
+
method: "GET",
|
|
2369
|
+
summary: "Get team usage",
|
|
2370
|
+
description: "Get the MCP request usage of a team for its current billing window. A team that has made no request in the window reports zero.",
|
|
2371
|
+
tags: ["teams"],
|
|
2372
|
+
successDescription: "The current billing window usage"
|
|
2373
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2374
|
+
teamId: z.string(),
|
|
2375
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2376
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2377
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2378
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2379
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2380
|
+
}));
|
|
2381
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1727
2382
|
path: "/v1/tunnels/ticket",
|
|
1728
2383
|
method: "GET",
|
|
1729
2384
|
summary: "Get a tunnel ticket",
|
|
@@ -1735,16 +2390,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1735
2390
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1736
2391
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1737
2392
|
}));
|
|
1738
|
-
const publishServerContractV1 =
|
|
2393
|
+
const publishServerContractV1 = base.route({
|
|
1739
2394
|
path: "/v1/distribution/publish",
|
|
1740
2395
|
method: "POST",
|
|
1741
2396
|
summary: "Publish a server to the MCP registry",
|
|
1742
2397
|
tags: ["distribution"],
|
|
1743
2398
|
successDescription: "The server has been published successfully"
|
|
1744
|
-
}).errors({
|
|
1745
|
-
NOT_FOUND: {},
|
|
1746
|
-
BAD_REQUEST: {}
|
|
1747
|
-
}).input(z.object({
|
|
2399
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1748
2400
|
projectId: z.string(),
|
|
1749
2401
|
domain: z.string(),
|
|
1750
2402
|
title: z.string().min(1).max(100),
|
|
@@ -1753,17 +2405,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1753
2405
|
iconSrc: z.url().max(255).optional(),
|
|
1754
2406
|
dryRun: z.boolean().optional()
|
|
1755
2407
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1756
|
-
const getServerInfoContractV1 =
|
|
2408
|
+
const getServerInfoContractV1 = base.route({
|
|
1757
2409
|
path: "/v1/distribution/get",
|
|
1758
2410
|
method: "GET",
|
|
1759
2411
|
summary: "Get server info",
|
|
1760
2412
|
description: "Get info about a server",
|
|
1761
2413
|
tags: ["distribution"],
|
|
1762
2414
|
successDescription: "The server info"
|
|
1763
|
-
}).errors({
|
|
1764
|
-
NOT_FOUND: {},
|
|
1765
|
-
BAD_REQUEST: {}
|
|
1766
|
-
}).input(z.object({
|
|
2415
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1767
2416
|
projectId: z.string(),
|
|
1768
2417
|
domain: z.string()
|
|
1769
2418
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1782,7 +2431,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1782
2431
|
isPlaygroundEnabled: z.boolean(),
|
|
1783
2432
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1784
2433
|
});
|
|
1785
|
-
const getPlaygroundContractV1 =
|
|
2434
|
+
const getPlaygroundContractV1 = base.route({
|
|
1786
2435
|
path: "/v1/environments/{environmentId}/playground",
|
|
1787
2436
|
method: "GET",
|
|
1788
2437
|
summary: "Get playground configuration",
|
|
@@ -1790,17 +2439,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1790
2439
|
tags: ["environments"],
|
|
1791
2440
|
successDescription: "The playground configuration"
|
|
1792
2441
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1793
|
-
const upsertPlaygroundContractV1 =
|
|
2442
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1794
2443
|
path: "/v1/environments/{environmentId}/playground",
|
|
1795
2444
|
method: "PUT",
|
|
1796
2445
|
summary: "Update playground configuration",
|
|
1797
2446
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1798
2447
|
tags: ["environments"],
|
|
1799
2448
|
successDescription: "The updated playground configuration"
|
|
1800
|
-
}).errors({
|
|
1801
|
-
NOT_FOUND: {},
|
|
1802
|
-
BAD_REQUEST: {}
|
|
1803
|
-
}).input(z.object({
|
|
2449
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1804
2450
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1805
2451
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1806
2452
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1808,7 +2454,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1808
2454
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1809
2455
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1810
2456
|
})).output(playgroundOutputSchema);
|
|
1811
|
-
const createBeaconContractV1 =
|
|
2457
|
+
const createBeaconContractV1 = base.route({
|
|
1812
2458
|
path: "/v1/beacon/audits",
|
|
1813
2459
|
method: "POST",
|
|
1814
2460
|
summary: "Create a beacon audit",
|
|
@@ -1817,7 +2463,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1817
2463
|
successDescription: "The audit has been created"
|
|
1818
2464
|
}).errors({
|
|
1819
2465
|
NOT_FOUND: {},
|
|
1820
|
-
BAD_REQUEST: {},
|
|
1821
2466
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1822
2467
|
}).input(z.object({
|
|
1823
2468
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1825,7 +2470,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1825
2470
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1826
2471
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1827
2472
|
})).output(z.object({ id: z.string() }));
|
|
1828
|
-
const getBeaconContractV1 =
|
|
2473
|
+
const getBeaconContractV1 = base.route({
|
|
1829
2474
|
path: "/v1/beacon/audits/{auditId}",
|
|
1830
2475
|
method: "GET",
|
|
1831
2476
|
summary: "Get a beacon audit",
|
|
@@ -1840,9 +2485,73 @@ const getBeaconContractV1 = oc.route({
|
|
|
1840
2485
|
createdAt: z.coerce.date(),
|
|
1841
2486
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1842
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);
|
|
1843
2539
|
const contract = {
|
|
1844
|
-
teams: {
|
|
2540
|
+
teams: {
|
|
2541
|
+
list: { v1: listTeamsContractV1 },
|
|
2542
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2543
|
+
},
|
|
1845
2544
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
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
|
+
},
|
|
2554
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1846
2555
|
deployments: {
|
|
1847
2556
|
list: { v1: listDeploymentsContractV1 },
|
|
1848
2557
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1852,6 +2561,7 @@ const contract = {
|
|
|
1852
2561
|
environments: {
|
|
1853
2562
|
create: { v1: createEnvironmentContractV1 },
|
|
1854
2563
|
get: { v1: getEnvironmentContractV1 },
|
|
2564
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1855
2565
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1856
2566
|
getLogs: { v1: getLogsContractV1 },
|
|
1857
2567
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1862,6 +2572,12 @@ const contract = {
|
|
|
1862
2572
|
update: { v1: updateEnvironmentVariableContractV1 },
|
|
1863
2573
|
delete: { v1: deleteEnvironmentVariableContractV1 }
|
|
1864
2574
|
},
|
|
2575
|
+
telemetryDestinations: {
|
|
2576
|
+
list: { v1: listTelemetryDestinationsContractV1 },
|
|
2577
|
+
create: { v1: createTelemetryDestinationContractV1 },
|
|
2578
|
+
update: { v1: updateTelemetryDestinationContractV1 },
|
|
2579
|
+
delete: { v1: deleteTelemetryDestinationContractV1 }
|
|
2580
|
+
},
|
|
1865
2581
|
projects: {
|
|
1866
2582
|
update: { v1: updateProjectContractV1 },
|
|
1867
2583
|
get: { v1: getProjectContractV1 },
|
|
@@ -1881,7 +2597,39 @@ const contract = {
|
|
|
1881
2597
|
beacon: {
|
|
1882
2598
|
create: { v1: createBeaconContractV1 },
|
|
1883
2599
|
get: { v1: getBeaconContractV1 }
|
|
2600
|
+
},
|
|
2601
|
+
submissions: {
|
|
2602
|
+
create: { v1: createSubmissionContractV1 },
|
|
2603
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2604
|
+
get: { v1: getSubmissionContractV1 },
|
|
2605
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2606
|
+
}
|
|
2607
|
+
};
|
|
2608
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2609
|
+
const contractForDocs = {
|
|
2610
|
+
...contract,
|
|
2611
|
+
deployments: deploymentsForDocs
|
|
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 }
|
|
1884
2632
|
}
|
|
1885
2633
|
};
|
|
1886
2634
|
//#endregion
|
|
1887
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, 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 };
|