@alpic-ai/api 0.0.0-dev.gf521008 → 0.0.0-dev.gf54b5dd
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 +6267 -94
- package/dist/index.mjs +858 -215
- package/package.json +26 -10
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.30.0_supports-color@7.2.0_zod@4.5.4/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -169,11 +169,22 @@ z$1.object({
|
|
|
169
169
|
token: z$1.string(),
|
|
170
170
|
token_type_hint: z$1.string().optional()
|
|
171
171
|
}).strip();
|
|
172
|
-
|
|
172
|
+
//#endregion
|
|
173
|
+
//#region ../domains/dist/index.mjs
|
|
174
|
+
const AI_PLATFORMS = ["chatgpt", "claudeai"];
|
|
175
|
+
const platformSchema = z.enum(AI_PLATFORMS);
|
|
173
176
|
const PLATFORM_LABELS = {
|
|
174
177
|
chatgpt: "ChatGPT",
|
|
175
178
|
claudeai: "Claude.ai"
|
|
176
179
|
};
|
|
180
|
+
const WAF_PLATFORMS = [
|
|
181
|
+
"akamai",
|
|
182
|
+
"cato",
|
|
183
|
+
"cloudflare",
|
|
184
|
+
"fastly"
|
|
185
|
+
];
|
|
186
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
187
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
177
188
|
const auditStatusSchema = z.enum([
|
|
178
189
|
"pending",
|
|
179
190
|
"partial",
|
|
@@ -246,6 +257,25 @@ z.object({
|
|
|
246
257
|
clientSecret: z.string(),
|
|
247
258
|
clientScopes: z.array(z.string())
|
|
248
259
|
});
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"admin_adjustment"
|
|
266
|
+
]);
|
|
267
|
+
z.enum(["playground"]);
|
|
268
|
+
z.number().int().min(500);
|
|
269
|
+
const creditActivityEntrySchema = z.object({
|
|
270
|
+
reason: creditEntryReasonSchema,
|
|
271
|
+
day: z.number(),
|
|
272
|
+
amountInNanoUSD: z.number(),
|
|
273
|
+
messageCount: z.number().nullable()
|
|
274
|
+
});
|
|
275
|
+
z.object({
|
|
276
|
+
balanceInNanoUSD: z.number(),
|
|
277
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
278
|
+
});
|
|
249
279
|
const deploymentStatusSchema$1 = z.enum([
|
|
250
280
|
"ongoing",
|
|
251
281
|
"deployed",
|
|
@@ -273,34 +303,51 @@ const deploymentSummarySchema = z.object({
|
|
|
273
303
|
createdAt: z.coerce.date(),
|
|
274
304
|
updatedAt: z.coerce.date()
|
|
275
305
|
});
|
|
276
|
-
/**
|
|
277
|
-
* Public environment
|
|
278
|
-
*
|
|
279
|
-
* No OAuth metadata exposed.
|
|
280
|
-
*/
|
|
306
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
281
307
|
const publicEnvironmentSchema = z.object({
|
|
308
|
+
allowsAnonymous: z.literal(true),
|
|
309
|
+
oAuthMetadata: z.strictObject({})
|
|
310
|
+
});
|
|
311
|
+
/** 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. */
|
|
312
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
313
|
+
allowsAnonymous: z.boolean(),
|
|
314
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
315
|
+
scope: z.string().optional()
|
|
316
|
+
});
|
|
317
|
+
/** 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. */
|
|
318
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
319
|
+
allowsAnonymous: z.boolean(),
|
|
320
|
+
oAuthMetadata: z.object({
|
|
321
|
+
externalAuthorizationServerUrl: z.url(),
|
|
322
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
323
|
+
}),
|
|
324
|
+
scope: z.string().optional()
|
|
325
|
+
});
|
|
326
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
327
|
+
const standaloneEnvironmentSchema = z.object({
|
|
328
|
+
allowsAnonymous: z.boolean(),
|
|
329
|
+
oAuthMetadata: z.object({
|
|
330
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
331
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
332
|
+
}),
|
|
333
|
+
scope: z.string().optional()
|
|
334
|
+
});
|
|
335
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
336
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
337
|
+
allowsAnonymous: z.literal(false),
|
|
338
|
+
oAuthMetadata: z.strictObject({}),
|
|
339
|
+
scope: z.string().optional()
|
|
340
|
+
});
|
|
341
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
282
342
|
isPublic: z.literal(true),
|
|
283
343
|
oAuthMetadata: z.undefined().optional()
|
|
284
344
|
});
|
|
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({
|
|
345
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
292
346
|
isPublic: z.literal(false),
|
|
293
347
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
348
|
scope: z.string().optional()
|
|
295
349
|
});
|
|
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({
|
|
350
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
351
|
isPublic: z.literal(false),
|
|
305
352
|
oAuthMetadata: z.object({
|
|
306
353
|
externalAuthorizationServerUrl: z.url(),
|
|
@@ -308,13 +355,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
308
355
|
}),
|
|
309
356
|
scope: z.string().optional()
|
|
310
357
|
});
|
|
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({
|
|
358
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
318
359
|
isPublic: z.literal(false),
|
|
319
360
|
oAuthMetadata: z.object({
|
|
320
361
|
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
@@ -322,14 +363,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
322
363
|
}),
|
|
323
364
|
scope: z.string().optional()
|
|
324
365
|
});
|
|
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({
|
|
366
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
367
|
isPublic: z.literal(false),
|
|
334
368
|
oAuthMetadata: z.strictObject({}),
|
|
335
369
|
scope: z.string().optional()
|
|
@@ -339,9 +373,13 @@ z.union([
|
|
|
339
373
|
externalResourceMetadataEnvironmentSchema,
|
|
340
374
|
externalAuthorizationServerEnvironmentSchema,
|
|
341
375
|
standaloneEnvironmentSchema,
|
|
342
|
-
protectedWithoutDiscoveryEnvironmentSchema
|
|
376
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
377
|
+
legacyPublicEnvironmentSchema,
|
|
378
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
379
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
380
|
+
legacyStandaloneEnvironmentSchema,
|
|
381
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
343
382
|
]);
|
|
344
|
-
const allowedPlatformSchema = platformSchema;
|
|
345
383
|
const playgroundModelSchema = z.enum([
|
|
346
384
|
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
347
385
|
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
@@ -381,14 +419,16 @@ z.object({
|
|
|
381
419
|
collectRequestPayload: z.boolean(),
|
|
382
420
|
collectResponsePayload: z.boolean(),
|
|
383
421
|
collectErrorMessage: z.boolean(),
|
|
384
|
-
collectUserData: z.boolean()
|
|
422
|
+
collectUserData: z.boolean(),
|
|
423
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
385
424
|
});
|
|
386
|
-
z.object({
|
|
425
|
+
const feedbackSchema = z.object({
|
|
387
426
|
id: z.string(),
|
|
388
427
|
createdAt: z.coerce.date(),
|
|
389
428
|
environmentId: z.string(),
|
|
390
429
|
content: z.string(),
|
|
391
|
-
source: z.enum(["model", "user"])
|
|
430
|
+
source: z.enum(["model", "user"]),
|
|
431
|
+
clientName: z.string().nullable()
|
|
392
432
|
});
|
|
393
433
|
z.object({
|
|
394
434
|
content: z.string(),
|
|
@@ -404,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
404
444
|
"pink",
|
|
405
445
|
"gray"
|
|
406
446
|
]);
|
|
407
|
-
intentCategoryColorSchema.options;
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
408
448
|
const intentCategorySchema = z.object({
|
|
409
449
|
id: z.string(),
|
|
410
450
|
createdAt: z.coerce.date(),
|
|
@@ -412,7 +452,7 @@ const intentCategorySchema = z.object({
|
|
|
412
452
|
name: z.string(),
|
|
413
453
|
color: intentCategoryColorSchema
|
|
414
454
|
});
|
|
415
|
-
z.object({
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
416
456
|
id: z.string(),
|
|
417
457
|
name: z.string(),
|
|
418
458
|
color: intentCategoryColorSchema,
|
|
@@ -424,6 +464,7 @@ z.object({
|
|
|
424
464
|
environmentId: z.string(),
|
|
425
465
|
toolName: z.string(),
|
|
426
466
|
message: z.string(),
|
|
467
|
+
clientName: z.string().nullable(),
|
|
427
468
|
categories: z.array(intentCategorySchema)
|
|
428
469
|
});
|
|
429
470
|
const signalCategorySchema = z.object({
|
|
@@ -482,12 +523,262 @@ z.object({
|
|
|
482
523
|
createdAt: z.coerce.date(),
|
|
483
524
|
updatedAt: z.coerce.date()
|
|
484
525
|
});
|
|
526
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
527
|
+
type: z.literal("mcp_request"),
|
|
528
|
+
method: z.string()
|
|
529
|
+
});
|
|
530
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
531
|
+
type: z.literal("mcp_error"),
|
|
532
|
+
method: z.string(),
|
|
533
|
+
error: z.string()
|
|
534
|
+
});
|
|
535
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
485
536
|
z.enum([
|
|
486
537
|
"INFO",
|
|
487
538
|
"WARNING",
|
|
488
539
|
"DEBUG",
|
|
489
540
|
"ERROR"
|
|
490
541
|
]);
|
|
542
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
543
|
+
const MCP_CLIENT_GROUPS = [
|
|
544
|
+
{
|
|
545
|
+
id: "claude_code",
|
|
546
|
+
label: "Claude Code",
|
|
547
|
+
vendor: "anthropic",
|
|
548
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
id: "claude",
|
|
552
|
+
label: "Claude",
|
|
553
|
+
vendor: "anthropic",
|
|
554
|
+
rawNames: [
|
|
555
|
+
"Anthropic/ClaudeAI",
|
|
556
|
+
"claude-ai",
|
|
557
|
+
"claude",
|
|
558
|
+
"Claude",
|
|
559
|
+
"claude-desktop",
|
|
560
|
+
"claude-desktop-3p"
|
|
561
|
+
]
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
id: "claude_mobile",
|
|
565
|
+
label: "Claude mobile",
|
|
566
|
+
vendor: "anthropic",
|
|
567
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
id: "claude_cowork",
|
|
571
|
+
label: "Claude Cowork",
|
|
572
|
+
vendor: "anthropic",
|
|
573
|
+
rawNames: ["Anthropic/Cowork"]
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
id: "claude_toolbox",
|
|
577
|
+
label: "Claude Toolbox",
|
|
578
|
+
vendor: "anthropic",
|
|
579
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
id: "anthropic_api",
|
|
583
|
+
label: "Anthropic API",
|
|
584
|
+
vendor: "anthropic",
|
|
585
|
+
rawNames: ["Anthropic/API"]
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
id: "anthropic_connector_refresh",
|
|
589
|
+
label: "Anthropic (connector refresh)",
|
|
590
|
+
vendor: "anthropic",
|
|
591
|
+
rawNames: ["Anthropic"]
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
id: "codex",
|
|
595
|
+
label: "Codex",
|
|
596
|
+
vendor: "openai",
|
|
597
|
+
rawNames: [
|
|
598
|
+
"codex-mcp-client",
|
|
599
|
+
"codex",
|
|
600
|
+
"Codex",
|
|
601
|
+
"codex-cli",
|
|
602
|
+
"openai-mcp (Codex)"
|
|
603
|
+
]
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
id: "chatgpt",
|
|
607
|
+
label: "ChatGPT",
|
|
608
|
+
vendor: "openai",
|
|
609
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
id: "openai_responses_api",
|
|
613
|
+
label: "OpenAI Responses API",
|
|
614
|
+
vendor: "openai",
|
|
615
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
id: "openai_agent_builder",
|
|
619
|
+
label: "OpenAI Agent Builder",
|
|
620
|
+
vendor: "openai",
|
|
621
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
id: "openai_other",
|
|
625
|
+
label: "OpenAI Other",
|
|
626
|
+
vendor: "openai",
|
|
627
|
+
rawNames: ["openai-mcp"]
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
id: "cursor",
|
|
631
|
+
label: "Cursor",
|
|
632
|
+
vendor: "cursor",
|
|
633
|
+
rawNames: [
|
|
634
|
+
"cursor-vscode",
|
|
635
|
+
"Cursor",
|
|
636
|
+
"cursor"
|
|
637
|
+
]
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
id: "cline",
|
|
641
|
+
label: "Cline",
|
|
642
|
+
vendor: "cline",
|
|
643
|
+
rawNames: [
|
|
644
|
+
"Cline",
|
|
645
|
+
"cline",
|
|
646
|
+
"@cline/core"
|
|
647
|
+
]
|
|
648
|
+
},
|
|
649
|
+
{
|
|
650
|
+
id: "github_copilot",
|
|
651
|
+
label: "GitHub Copilot",
|
|
652
|
+
vendor: "githubCopilot",
|
|
653
|
+
rawNames: [
|
|
654
|
+
"Copilot",
|
|
655
|
+
"github-copilot-developer",
|
|
656
|
+
"Copilot MCP Gateway",
|
|
657
|
+
"Xcode/copilot-xcode"
|
|
658
|
+
]
|
|
659
|
+
},
|
|
660
|
+
{
|
|
661
|
+
id: "gemini_cli",
|
|
662
|
+
label: "Gemini CLI",
|
|
663
|
+
vendor: "google",
|
|
664
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
id: "antigravity",
|
|
668
|
+
label: "Antigravity",
|
|
669
|
+
vendor: "google",
|
|
670
|
+
rawNames: ["antigravity-client"]
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
id: "gemini",
|
|
674
|
+
label: "Gemini",
|
|
675
|
+
vendor: "google",
|
|
676
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
id: "windsurf",
|
|
680
|
+
label: "Windsurf",
|
|
681
|
+
vendor: "windsurf",
|
|
682
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
683
|
+
},
|
|
684
|
+
{
|
|
685
|
+
id: "mistral",
|
|
686
|
+
label: "Mistral / Le Chat",
|
|
687
|
+
vendor: "mistral",
|
|
688
|
+
rawNames: ["Mistral"],
|
|
689
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
id: "n8n",
|
|
693
|
+
label: "n8n",
|
|
694
|
+
vendor: "n8n",
|
|
695
|
+
rawNames: [
|
|
696
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
697
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
698
|
+
"n8n"
|
|
699
|
+
]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "alpic_playground",
|
|
703
|
+
label: "Alpic Playground",
|
|
704
|
+
vendor: "alpic",
|
|
705
|
+
rawNames: ["alpic-playground", "playground"]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
id: "opencode",
|
|
709
|
+
label: "opencode",
|
|
710
|
+
vendor: "opencode",
|
|
711
|
+
rawNames: ["opencode"]
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
id: "zed",
|
|
715
|
+
label: "Zed",
|
|
716
|
+
vendor: "zed",
|
|
717
|
+
rawNames: ["Zed", "zed"]
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
id: "zapier",
|
|
721
|
+
label: "Zapier",
|
|
722
|
+
vendor: "zapier",
|
|
723
|
+
rawNames: ["Zapier", "zapier"]
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
id: "make",
|
|
727
|
+
label: "Make",
|
|
728
|
+
vendor: "make",
|
|
729
|
+
rawNames: ["Make", "make"]
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
id: "librechat",
|
|
733
|
+
label: "LibreChat",
|
|
734
|
+
vendor: "mcp",
|
|
735
|
+
rawNames: ["LibreChat", "librechat"]
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
id: "jan",
|
|
739
|
+
label: "Jan",
|
|
740
|
+
vendor: "mcp",
|
|
741
|
+
rawNames: ["Jan", "jan"]
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
id: "goose",
|
|
745
|
+
label: "goose",
|
|
746
|
+
vendor: "mcp",
|
|
747
|
+
rawNames: ["goose", "Goose"]
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
id: "mcphost",
|
|
751
|
+
label: "mcphost",
|
|
752
|
+
vendor: "mcp",
|
|
753
|
+
rawNames: ["mcphost"]
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
id: "mcporter",
|
|
757
|
+
label: "mcporter",
|
|
758
|
+
vendor: "mcp",
|
|
759
|
+
rawNames: ["mcporter"]
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
id: "rmcp",
|
|
763
|
+
label: "rmcp",
|
|
764
|
+
vendor: "mcp",
|
|
765
|
+
rawNames: ["rmcp"]
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
id: "unnamed_client",
|
|
769
|
+
label: "Unnamed client",
|
|
770
|
+
vendor: "mcp",
|
|
771
|
+
rawNames: [
|
|
772
|
+
"mcp",
|
|
773
|
+
"unknown",
|
|
774
|
+
""
|
|
775
|
+
]
|
|
776
|
+
}
|
|
777
|
+
];
|
|
778
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
779
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
780
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
781
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
491
782
|
const runtimeSchema = z.enum([
|
|
492
783
|
"python3.13",
|
|
493
784
|
"python3.14",
|
|
@@ -522,6 +813,10 @@ const domainFailureReasonSchema = z.enum([
|
|
|
522
813
|
"invalid_domain",
|
|
523
814
|
"other"
|
|
524
815
|
]);
|
|
816
|
+
const projectDomainMappingSchema = z.object({
|
|
817
|
+
pathPrefix: z.string(),
|
|
818
|
+
environment: environmentSchema$1
|
|
819
|
+
});
|
|
525
820
|
z.object({
|
|
526
821
|
name: z.string(),
|
|
527
822
|
createdAt: z.coerce.date(),
|
|
@@ -531,7 +826,8 @@ z.object({
|
|
|
531
826
|
"failed"
|
|
532
827
|
]),
|
|
533
828
|
failureReason: domainFailureReasonSchema.nullable(),
|
|
534
|
-
environment: environmentSchema$1
|
|
829
|
+
environment: environmentSchema$1,
|
|
830
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
535
831
|
});
|
|
536
832
|
const serverFieldsSchema$1 = z.object({
|
|
537
833
|
$schema: z.string(),
|
|
@@ -560,15 +856,7 @@ z.object({
|
|
|
560
856
|
serverFields: serverFieldsSchema$1,
|
|
561
857
|
source: z.enum(["registry", "defaults"])
|
|
562
858
|
});
|
|
563
|
-
/**
|
|
564
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
565
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
566
|
-
*
|
|
567
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
568
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
569
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
570
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
571
|
-
*/
|
|
859
|
+
/** 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. */
|
|
572
860
|
const clampStringField = (field) => {
|
|
573
861
|
const max = field.maxLength;
|
|
574
862
|
if (max === null) return field;
|
|
@@ -576,6 +864,10 @@ const clampStringField = (field) => {
|
|
|
576
864
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
577
865
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
578
866
|
};
|
|
867
|
+
const unboundedArrayField = (field) => {
|
|
868
|
+
const unbounded = z.array(field.element);
|
|
869
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
870
|
+
};
|
|
579
871
|
const toolDefinitionSchema = z.object({
|
|
580
872
|
name: z.string(),
|
|
581
873
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -588,15 +880,27 @@ const toolDefinitionSchema = z.object({
|
|
|
588
880
|
}).optional()
|
|
589
881
|
});
|
|
590
882
|
const positiveTestCaseSchema = z.object({
|
|
591
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
592
|
-
userPrompt: z.string().describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
883
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
884
|
+
userPrompt: z.string().min(1).describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
593
885
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
594
886
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
595
|
-
}).
|
|
887
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
888
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
889
|
+
scenario: z.string().optional(),
|
|
890
|
+
userPrompt: z.string().optional()
|
|
891
|
+
});
|
|
892
|
+
const blankPositiveTestCase = () => ({
|
|
893
|
+
scenario: "",
|
|
894
|
+
userPrompt: "",
|
|
895
|
+
toolTriggered: "",
|
|
896
|
+
expectedOutput: ""
|
|
897
|
+
});
|
|
898
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
596
899
|
const screenshotEntrySchema = z.object({
|
|
597
900
|
prompt: z.string(),
|
|
598
|
-
url: z.url()
|
|
901
|
+
url: z.url()
|
|
599
902
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
903
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
600
904
|
/** Accepts either a valid email or URL. */
|
|
601
905
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
602
906
|
/** A URL field whose error spells out that the scheme is required. */
|
|
@@ -904,20 +1208,25 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
904
1208
|
"zh-TW"
|
|
905
1209
|
]);
|
|
906
1210
|
const negativeTestCaseSchema = z.object({
|
|
907
|
-
scenario: z.string(),
|
|
908
|
-
userPrompt: z.string()
|
|
909
|
-
}).
|
|
1211
|
+
scenario: z.string().min(1),
|
|
1212
|
+
userPrompt: z.string().min(1)
|
|
1213
|
+
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1214
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1215
|
+
scenario: z.string().optional(),
|
|
1216
|
+
userPrompt: z.string().optional()
|
|
1217
|
+
});
|
|
1218
|
+
const blankNegativeTestCase = () => ({
|
|
1219
|
+
scenario: "",
|
|
1220
|
+
userPrompt: ""
|
|
1221
|
+
});
|
|
1222
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
910
1223
|
const chatgptToolJustificationSchema = z.object({
|
|
911
1224
|
toolName: z.string(),
|
|
912
1225
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
913
1226
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
914
1227
|
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.\"")
|
|
915
1228
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
916
|
-
/**
|
|
917
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
918
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
919
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
920
|
-
*/
|
|
1229
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
921
1230
|
const chatgptTaglineSchema = z.string().max(30);
|
|
922
1231
|
const chatgptDescriptionSchema = z.string();
|
|
923
1232
|
const chatgptTranslationSchema = z.object({
|
|
@@ -926,10 +1235,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
926
1235
|
description: chatgptDescriptionSchema
|
|
927
1236
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
928
1237
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
929
|
-
/**
|
|
930
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
931
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
932
|
-
*/
|
|
1238
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
933
1239
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
934
1240
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
935
1241
|
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."),
|
|
@@ -948,28 +1254,52 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
948
1254
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
949
1255
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
950
1256
|
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
|
|
951
|
-
|
|
952
|
-
|
|
1257
|
+
skills: z.array(chatgptSkillSchema).optional().describe("Skills the server exposes over MCP (auto-populated from the production server's manifest). Left unset when the server does not advertise the skills extension, which is a different state from advertising it and exposing none."),
|
|
1258
|
+
testCases: z.array(positiveTestCaseSchema).length(5).describe("Exactly 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Collectively cover the full capability across different flow stages (initial search or browse, market or locale handling, post-interaction detail, an action ChatGPT performs on the user's behalf, and a conversion or secondary tool) rather than five variations of the same first step."),
|
|
1259
|
+
negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
953
1260
|
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
954
1261
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
955
1262
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
956
1263
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
957
1264
|
});
|
|
958
|
-
chatgptSubmissionFormDataSchema.
|
|
1265
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1266
|
+
tagline: z.string().optional(),
|
|
1267
|
+
companyUrl: z.string().optional(),
|
|
1268
|
+
supportChannel: z.string().optional(),
|
|
1269
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1270
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1271
|
+
demoRecordingUrl: z.string().optional(),
|
|
1272
|
+
serverUrl: z.string().optional(),
|
|
1273
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1274
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1275
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1276
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1277
|
+
});
|
|
1278
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1279
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
959
1280
|
appName: true,
|
|
960
1281
|
developerName: true,
|
|
961
1282
|
serverUrl: true,
|
|
962
1283
|
tools: true,
|
|
1284
|
+
skills: true,
|
|
963
1285
|
authentication: true
|
|
964
1286
|
});
|
|
965
|
-
|
|
1287
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1288
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
966
1289
|
tagline: true,
|
|
967
1290
|
description: true,
|
|
968
1291
|
category: true,
|
|
969
1292
|
testCases: true,
|
|
970
1293
|
negativeTestCases: true,
|
|
971
1294
|
toolJustifications: true
|
|
972
|
-
}).extend({
|
|
1295
|
+
}).extend({
|
|
1296
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1297
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1298
|
+
}).extend({
|
|
1299
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1300
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1301
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1302
|
+
});
|
|
973
1303
|
const claudeCategorySchema = z.enum([
|
|
974
1304
|
"Productivity",
|
|
975
1305
|
"Communication",
|
|
@@ -1015,11 +1345,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1015
1345
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1016
1346
|
"Public documentation for this connector will be live by the publish date."
|
|
1017
1347
|
]);
|
|
1018
|
-
/**
|
|
1019
|
-
* Field order mirrors the claude.ai directory submission wizard
|
|
1020
|
-
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1021
|
-
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1022
|
-
*/
|
|
1348
|
+
/** 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. */
|
|
1023
1349
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1024
1350
|
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
|
|
1025
1351
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1081,7 +1407,23 @@ fully populated account.`),
|
|
|
1081
1407
|
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1082
1408
|
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1083
1409
|
});
|
|
1084
|
-
claudeSubmissionFormDataSchema.
|
|
1410
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1411
|
+
serverUrl: z.string().optional(),
|
|
1412
|
+
name: z.string().optional(),
|
|
1413
|
+
slug: z.string().optional(),
|
|
1414
|
+
oneLiner: z.string().optional(),
|
|
1415
|
+
description: z.string().optional(),
|
|
1416
|
+
iconUrl: z.string().optional(),
|
|
1417
|
+
documentation: z.string().optional(),
|
|
1418
|
+
support: z.string().optional(),
|
|
1419
|
+
privacyPolicy: z.string().optional(),
|
|
1420
|
+
companyWebsite: z.string().optional(),
|
|
1421
|
+
primaryContactEmail: z.string().optional(),
|
|
1422
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1423
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1424
|
+
});
|
|
1425
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1426
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1085
1427
|
serverUrl: true,
|
|
1086
1428
|
name: true,
|
|
1087
1429
|
slug: true,
|
|
@@ -1096,39 +1438,93 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1096
1438
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1097
1439
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1098
1440
|
});
|
|
1099
|
-
/**
|
|
1100
|
-
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1101
|
-
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1102
|
-
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1103
|
-
* colocated with the Claude contract.
|
|
1104
|
-
*/
|
|
1441
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1105
1442
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1106
1443
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1107
1444
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1108
1445
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1109
1446
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1110
1447
|
});
|
|
1111
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1448
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1112
1449
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1113
1450
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1114
1451
|
});
|
|
1452
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1453
|
+
const byField = {};
|
|
1454
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1455
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1456
|
+
return byField;
|
|
1457
|
+
}
|
|
1458
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1459
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1460
|
+
"pass",
|
|
1461
|
+
"fail",
|
|
1462
|
+
"unverified"
|
|
1463
|
+
]);
|
|
1464
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1465
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1466
|
+
claudeai: ["privacyPolicy"]
|
|
1467
|
+
};
|
|
1468
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1469
|
+
const policyDisclosureSchema = z.enum([
|
|
1470
|
+
"dataCategories",
|
|
1471
|
+
"purposesOfUse",
|
|
1472
|
+
"recipients",
|
|
1473
|
+
"retention"
|
|
1474
|
+
]);
|
|
1475
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1476
|
+
field: verifiableUrlFieldSchema,
|
|
1477
|
+
url: z.string(),
|
|
1478
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1479
|
+
reason: z.string(),
|
|
1480
|
+
concerns: z.array(z.string()).optional(),
|
|
1481
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1482
|
+
});
|
|
1483
|
+
const urlVerificationSchema = z.object({
|
|
1484
|
+
verifiedAt: z.coerce.date(),
|
|
1485
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1486
|
+
});
|
|
1487
|
+
const pageKindSchema = z.enum([
|
|
1488
|
+
"expectedDocument",
|
|
1489
|
+
"errorPage",
|
|
1490
|
+
"loginWall",
|
|
1491
|
+
"parkedDomain",
|
|
1492
|
+
"comingSoon",
|
|
1493
|
+
"marketingPage",
|
|
1494
|
+
"unrelatedDocument"
|
|
1495
|
+
]);
|
|
1496
|
+
z.object({
|
|
1497
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1498
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1499
|
+
missingDisclosures: z.array(policyDisclosureSchema).describe("For a privacy policy only: which of the four required disclosures the text does not cover. Empty for every other page kind.")
|
|
1500
|
+
});
|
|
1115
1501
|
const submissionMetaFieldsSchema = z.object({
|
|
1116
1502
|
id: z.string(),
|
|
1117
1503
|
environmentId: z.string(),
|
|
1118
1504
|
auditId: z.string().nullable(),
|
|
1505
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1119
1506
|
createdAt: z.coerce.date(),
|
|
1120
1507
|
updatedAt: z.coerce.date()
|
|
1121
1508
|
});
|
|
1122
1509
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1123
1510
|
platform: z.literal("claudeai"),
|
|
1124
|
-
formData:
|
|
1511
|
+
formData: claudeSubmissionDraftSchema,
|
|
1512
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1125
1513
|
});
|
|
1126
1514
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1127
1515
|
platform: z.literal("chatgpt"),
|
|
1128
|
-
formData:
|
|
1516
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1517
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1129
1518
|
});
|
|
1130
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1131
|
-
z.union([
|
|
1519
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1520
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1521
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1522
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1523
|
+
z.literal([
|
|
1524
|
+
100,
|
|
1525
|
+
75,
|
|
1526
|
+
50
|
|
1527
|
+
]);
|
|
1132
1528
|
const subscriptionPlanSchema = z.enum([
|
|
1133
1529
|
"pro",
|
|
1134
1530
|
"business",
|
|
@@ -1140,17 +1536,70 @@ const customerCreditsSchema = z.object({
|
|
|
1140
1536
|
expiresAt: z.number().nullable(),
|
|
1141
1537
|
currency: z.string()
|
|
1142
1538
|
});
|
|
1143
|
-
const customerUsageSchema = z.object({
|
|
1144
|
-
amountInCents: z.number(),
|
|
1145
|
-
currency: z.string(),
|
|
1146
|
-
periodEnd: z.number()
|
|
1147
|
-
});
|
|
1148
1539
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1149
1540
|
z.object({
|
|
1150
1541
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1151
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1152
1542
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1153
1543
|
});
|
|
1544
|
+
const metricsQueueEventSchema = z.object({
|
|
1545
|
+
ts: z.number().int(),
|
|
1546
|
+
method: z.string(),
|
|
1547
|
+
tool: z.string().nullable(),
|
|
1548
|
+
client: z.string(),
|
|
1549
|
+
sessionId: z.string().nullable(),
|
|
1550
|
+
durationMs: z.number().int(),
|
|
1551
|
+
outputTokens: z.number().int().nullable(),
|
|
1552
|
+
errorType: z.enum([
|
|
1553
|
+
"mcp_error",
|
|
1554
|
+
"tool_error",
|
|
1555
|
+
"timeout"
|
|
1556
|
+
]).nullable(),
|
|
1557
|
+
errorCode: z.number().int().nullable()
|
|
1558
|
+
});
|
|
1559
|
+
z.object({
|
|
1560
|
+
v: z.literal(1),
|
|
1561
|
+
envId: z.string(),
|
|
1562
|
+
events: z.array(metricsQueueEventSchema)
|
|
1563
|
+
});
|
|
1564
|
+
z.object({ v: z.number() });
|
|
1565
|
+
const telemetrySignalSchema = z.enum([
|
|
1566
|
+
"logs",
|
|
1567
|
+
"metrics",
|
|
1568
|
+
"traces"
|
|
1569
|
+
]);
|
|
1570
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1571
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1572
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1573
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1574
|
+
const otlpHeaderValueSchema = z.string().trim().max(OTLP_HEADER_VALUE_MAX_LENGTH).refine((value) => !/[\r\n]/.test(value), "Line breaks are not allowed in a header value");
|
|
1575
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1576
|
+
id: z.string(),
|
|
1577
|
+
name: otlpHeaderNameSchema,
|
|
1578
|
+
value: otlpHeaderValueSchema,
|
|
1579
|
+
isSecret: z.boolean()
|
|
1580
|
+
});
|
|
1581
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1582
|
+
"credentials",
|
|
1583
|
+
"wrong-path",
|
|
1584
|
+
"wrong-protocol",
|
|
1585
|
+
"invalid-payload",
|
|
1586
|
+
"partial-rejection",
|
|
1587
|
+
"blocked-target",
|
|
1588
|
+
"timeout",
|
|
1589
|
+
"unreachable",
|
|
1590
|
+
"receiver-error",
|
|
1591
|
+
"unexpected-status"
|
|
1592
|
+
]);
|
|
1593
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1594
|
+
z.object({
|
|
1595
|
+
id: z.string(),
|
|
1596
|
+
signal: telemetrySignalSchema,
|
|
1597
|
+
endpoint: otlpEndpointSchema,
|
|
1598
|
+
protocol: otlpProtocolSchema,
|
|
1599
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1600
|
+
status: telemetryDestinationStatusSchema,
|
|
1601
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1602
|
+
});
|
|
1154
1603
|
//#endregion
|
|
1155
1604
|
//#region src/auth-scope.ts
|
|
1156
1605
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1193,7 +1642,10 @@ const RESERVED_KEYS = [
|
|
|
1193
1642
|
"BUILD_ARG_START_COMMAND",
|
|
1194
1643
|
"ALPIC_HOST",
|
|
1195
1644
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1196
|
-
"ALPIC_INTENT_META_KEY"
|
|
1645
|
+
"ALPIC_INTENT_META_KEY",
|
|
1646
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1647
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1648
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1197
1649
|
];
|
|
1198
1650
|
const environmentVariableSchema = z.object({
|
|
1199
1651
|
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"),
|
|
@@ -1246,6 +1698,14 @@ const serverFieldsSchema = z.object({
|
|
|
1246
1698
|
});
|
|
1247
1699
|
//#endregion
|
|
1248
1700
|
//#region src/api.contract.ts
|
|
1701
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1702
|
+
try {
|
|
1703
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1704
|
+
return true;
|
|
1705
|
+
} catch {
|
|
1706
|
+
return false;
|
|
1707
|
+
}
|
|
1708
|
+
};
|
|
1249
1709
|
const deploymentStatusSchema = z.enum([
|
|
1250
1710
|
"ongoing",
|
|
1251
1711
|
"deployed",
|
|
@@ -1274,21 +1734,20 @@ const deploymentSchema = z.object({
|
|
|
1274
1734
|
isCurrent: z.boolean(),
|
|
1275
1735
|
deploymentPageUrl: z.url().nullable()
|
|
1276
1736
|
});
|
|
1277
|
-
const
|
|
1737
|
+
const isValidTimeInput = (value) => {
|
|
1278
1738
|
if (ms(value) !== void 0) return true;
|
|
1279
1739
|
return !Number.isNaN(new Date(value).getTime());
|
|
1280
1740
|
};
|
|
1281
|
-
const
|
|
1741
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1742
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1743
|
+
const createEnvironmentContractV1 = base.route({
|
|
1282
1744
|
path: "/v1/environments",
|
|
1283
1745
|
method: "POST",
|
|
1284
1746
|
summary: "Create an environment",
|
|
1285
1747
|
description: "Create an environment for a project",
|
|
1286
1748
|
tags: ["environments"],
|
|
1287
1749
|
successDescription: "The environment has been created successfully"
|
|
1288
|
-
}).errors({
|
|
1289
|
-
NOT_FOUND: {},
|
|
1290
|
-
BAD_REQUEST: {}
|
|
1291
|
-
}).input(z.object({
|
|
1750
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1292
1751
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1293
1752
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1294
1753
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1301,7 +1760,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1301
1760
|
createdAt: z.coerce.date(),
|
|
1302
1761
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1303
1762
|
}));
|
|
1304
|
-
const getEnvironmentContractV1 =
|
|
1763
|
+
const getEnvironmentContractV1 = base.route({
|
|
1305
1764
|
path: "/v1/environments/{environmentId}",
|
|
1306
1765
|
method: "GET",
|
|
1307
1766
|
summary: "Get an environment",
|
|
@@ -1317,6 +1776,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1317
1776
|
createdAt: z.coerce.date(),
|
|
1318
1777
|
projectId: z.string()
|
|
1319
1778
|
}));
|
|
1779
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1780
|
+
path: "/v1/environments/{environmentId}",
|
|
1781
|
+
method: "DELETE",
|
|
1782
|
+
summary: "Delete an environment",
|
|
1783
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1784
|
+
tags: ["environments"],
|
|
1785
|
+
successDescription: "The environment has been deleted successfully"
|
|
1786
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1320
1787
|
const domainSchema = z.object({
|
|
1321
1788
|
domain: z.string(),
|
|
1322
1789
|
status: z.enum([
|
|
@@ -1358,7 +1825,7 @@ const projectOutputSchema = z.object({
|
|
|
1358
1825
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1359
1826
|
environments: z.array(environmentSchema)
|
|
1360
1827
|
});
|
|
1361
|
-
const getProjectContractV1 =
|
|
1828
|
+
const getProjectContractV1 = base.route({
|
|
1362
1829
|
path: "/v1/projects/{projectId}",
|
|
1363
1830
|
method: "GET",
|
|
1364
1831
|
summary: "Get a project",
|
|
@@ -1366,18 +1833,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1366
1833
|
tags: ["projects"],
|
|
1367
1834
|
successDescription: "The project details"
|
|
1368
1835
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1369
|
-
const listProjectsContractV1 =
|
|
1836
|
+
const listProjectsContractV1 = base.route({
|
|
1370
1837
|
path: "/v1/projects",
|
|
1371
1838
|
method: "GET",
|
|
1372
1839
|
summary: "List projects",
|
|
1373
1840
|
description: "List all projects for a team",
|
|
1374
1841
|
tags: ["projects"],
|
|
1375
1842
|
successDescription: "The list of projects"
|
|
1376
|
-
}).errors({
|
|
1377
|
-
|
|
1378
|
-
BAD_REQUEST: {}
|
|
1379
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1380
|
-
const createProjectContractV1 = oc.route({
|
|
1843
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1844
|
+
const createProjectContractV1 = base.route({
|
|
1381
1845
|
path: "/v1/projects",
|
|
1382
1846
|
method: "POST",
|
|
1383
1847
|
summary: "Create a project",
|
|
@@ -1386,7 +1850,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1386
1850
|
successDescription: "The project has been created successfully"
|
|
1387
1851
|
}).errors({
|
|
1388
1852
|
NOT_FOUND: {},
|
|
1389
|
-
BAD_REQUEST: {},
|
|
1390
1853
|
FORBIDDEN: {}
|
|
1391
1854
|
}).input(z.object({
|
|
1392
1855
|
teamId: z.string().optional(),
|
|
@@ -1427,7 +1890,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1427
1890
|
isSecret: z.boolean(),
|
|
1428
1891
|
createdAt: z.coerce.date()
|
|
1429
1892
|
});
|
|
1430
|
-
const listEnvironmentVariablesContractV1 =
|
|
1893
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1431
1894
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1432
1895
|
method: "GET",
|
|
1433
1896
|
summary: "List environment variables",
|
|
@@ -1435,48 +1898,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1435
1898
|
tags: ["environments"],
|
|
1436
1899
|
successDescription: "The list of environment variables"
|
|
1437
1900
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1438
|
-
const createEnvironmentVariablesContractV1 =
|
|
1901
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1439
1902
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1440
1903
|
method: "POST",
|
|
1441
1904
|
summary: "Add environment variables",
|
|
1442
1905
|
description: "Add one or more environment variables to an environment",
|
|
1443
1906
|
tags: ["environments"],
|
|
1444
1907
|
successDescription: "The environment variables have been added successfully"
|
|
1445
|
-
}).errors({
|
|
1446
|
-
NOT_FOUND: {},
|
|
1447
|
-
BAD_REQUEST: {}
|
|
1448
|
-
}).input(z.object({
|
|
1908
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1449
1909
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1450
1910
|
environmentVariables: environmentVariablesSchema
|
|
1451
1911
|
})).output(z.object({ success: z.literal(true) }));
|
|
1452
|
-
const updateEnvironmentVariableContractV1 =
|
|
1912
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1453
1913
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1454
1914
|
method: "PATCH",
|
|
1455
1915
|
summary: "Update an environment variable",
|
|
1456
1916
|
description: "Update an environment variable by ID",
|
|
1457
1917
|
tags: ["environments"],
|
|
1458
1918
|
successDescription: "The environment variable has been updated successfully"
|
|
1459
|
-
}).errors({
|
|
1460
|
-
NOT_FOUND: {},
|
|
1461
|
-
BAD_REQUEST: {}
|
|
1462
|
-
}).input(z.object({
|
|
1919
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1463
1920
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1464
1921
|
key: environmentVariableSchema.shape.key,
|
|
1465
1922
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1466
1923
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1467
1924
|
})).output(z.object({ success: z.literal(true) }));
|
|
1468
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1925
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1469
1926
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1470
1927
|
method: "DELETE",
|
|
1471
1928
|
summary: "Delete an environment variable",
|
|
1472
1929
|
description: "Delete an environment variable by ID",
|
|
1473
1930
|
tags: ["environments"],
|
|
1474
1931
|
successDescription: "The environment variable has been deleted successfully"
|
|
1475
|
-
}).errors({
|
|
1476
|
-
|
|
1477
|
-
BAD_REQUEST: {}
|
|
1478
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1479
|
-
const deleteProjectContractV1 = oc.route({
|
|
1932
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1933
|
+
const deleteProjectContractV1 = base.route({
|
|
1480
1934
|
path: "/v1/projects/{projectId}",
|
|
1481
1935
|
method: "DELETE",
|
|
1482
1936
|
summary: "Delete a project",
|
|
@@ -1484,7 +1938,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1484
1938
|
tags: ["projects"],
|
|
1485
1939
|
successDescription: "The project has been deleted successfully"
|
|
1486
1940
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1487
|
-
const updateProjectContractV1 =
|
|
1941
|
+
const updateProjectContractV1 = base.route({
|
|
1488
1942
|
path: "/v1/projects/{projectId}",
|
|
1489
1943
|
method: "PATCH",
|
|
1490
1944
|
summary: "Update a project",
|
|
@@ -1493,14 +1947,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1493
1947
|
successDescription: "The project has been updated successfully"
|
|
1494
1948
|
}).errors({
|
|
1495
1949
|
NOT_FOUND: {},
|
|
1496
|
-
BAD_REQUEST: {},
|
|
1497
1950
|
FORBIDDEN: {}
|
|
1498
1951
|
}).input(z.object({
|
|
1499
1952
|
projectId: z.string().describe("The ID of the project"),
|
|
1500
1953
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1501
1954
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1502
1955
|
})).output(projectOutputSchema);
|
|
1503
|
-
const deployEnvironmentContractV1 =
|
|
1956
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1504
1957
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1505
1958
|
method: "POST",
|
|
1506
1959
|
summary: "Deploy an environment",
|
|
@@ -1509,27 +1962,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1509
1962
|
successDescription: "The environment has been deployed successfully"
|
|
1510
1963
|
}).errors({
|
|
1511
1964
|
NOT_FOUND: {},
|
|
1512
|
-
|
|
1965
|
+
CONFLICT: {}
|
|
1513
1966
|
}).input(z.object({
|
|
1514
1967
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1515
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1968
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1969
|
+
settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
|
|
1516
1970
|
})).output(deploymentSchema);
|
|
1517
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1971
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1518
1972
|
path: "/v1/deployments/upload",
|
|
1519
1973
|
method: "POST",
|
|
1520
1974
|
summary: "Upload deployment artifacts",
|
|
1521
1975
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1522
1976
|
tags: ["deployments"],
|
|
1523
1977
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1524
|
-
}).errors({
|
|
1525
|
-
NOT_FOUND: {},
|
|
1526
|
-
BAD_REQUEST: {}
|
|
1527
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1978
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1528
1979
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1529
1980
|
token: z.string().describe("Token to identify the source archive"),
|
|
1530
1981
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1531
1982
|
}));
|
|
1532
|
-
const listDeploymentsContractV1 =
|
|
1983
|
+
const listDeploymentsContractV1 = base.route({
|
|
1533
1984
|
path: "/v1/projects/{projectId}/deployments",
|
|
1534
1985
|
method: "GET",
|
|
1535
1986
|
summary: "List project deployments",
|
|
@@ -1541,7 +1992,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1541
1992
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1542
1993
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1543
1994
|
})).output(z.array(deploymentSchema));
|
|
1544
|
-
const getDeploymentContractV1 =
|
|
1995
|
+
const getDeploymentContractV1 = base.route({
|
|
1545
1996
|
path: "/v1/deployments/{deploymentId}",
|
|
1546
1997
|
method: "GET",
|
|
1547
1998
|
summary: "Get a deployment",
|
|
@@ -1549,20 +2000,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1549
2000
|
tags: ["deployments"],
|
|
1550
2001
|
successDescription: "The deployment details"
|
|
1551
2002
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1552
|
-
const
|
|
2003
|
+
const logEntrySchema = z.object({
|
|
2004
|
+
timestamp: z.coerce.date(),
|
|
2005
|
+
type: z.enum([
|
|
2006
|
+
"START",
|
|
2007
|
+
"END",
|
|
2008
|
+
"INFO",
|
|
2009
|
+
"ERROR",
|
|
2010
|
+
"WARNING",
|
|
2011
|
+
"DEBUG"
|
|
2012
|
+
]),
|
|
2013
|
+
requestId: z.string(),
|
|
2014
|
+
content: z.string().optional(),
|
|
2015
|
+
method: z.string().optional(),
|
|
2016
|
+
durationInMs: z.number().optional()
|
|
2017
|
+
});
|
|
2018
|
+
const getLogsContractV1 = base.route({
|
|
1553
2019
|
path: "/v1/environments/{environmentId}/logs",
|
|
1554
2020
|
method: "GET",
|
|
1555
2021
|
summary: "Get logs",
|
|
1556
2022
|
description: "Get logs for an environment",
|
|
1557
2023
|
tags: ["environments"],
|
|
1558
2024
|
successDescription: "The logs"
|
|
1559
|
-
}).errors({
|
|
1560
|
-
NOT_FOUND: {},
|
|
1561
|
-
BAD_REQUEST: {}
|
|
1562
|
-
}).input(z.object({
|
|
2025
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1563
2026
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1564
|
-
since:
|
|
1565
|
-
until:
|
|
2027
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2028
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1566
2029
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1567
2030
|
level: z.array(z.enum([
|
|
1568
2031
|
"INFO",
|
|
@@ -1573,34 +2036,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1573
2036
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1574
2037
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1575
2038
|
})).output(z.object({
|
|
1576
|
-
logs: z.array(
|
|
1577
|
-
timestamp: z.coerce.date(),
|
|
1578
|
-
type: z.enum([
|
|
1579
|
-
"START",
|
|
1580
|
-
"END",
|
|
1581
|
-
"INFO",
|
|
1582
|
-
"ERROR",
|
|
1583
|
-
"WARNING",
|
|
1584
|
-
"DEBUG"
|
|
1585
|
-
]),
|
|
1586
|
-
requestId: z.string(),
|
|
1587
|
-
content: z.string().optional(),
|
|
1588
|
-
method: z.string().optional(),
|
|
1589
|
-
durationInMs: z.number().optional()
|
|
1590
|
-
})),
|
|
2039
|
+
logs: z.array(logEntrySchema),
|
|
1591
2040
|
nextToken: z.string().nullable()
|
|
1592
2041
|
}));
|
|
1593
|
-
const getLatestLogsContractV1 =
|
|
2042
|
+
const getLatestLogsContractV1 = base.route({
|
|
1594
2043
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1595
2044
|
method: "GET",
|
|
1596
2045
|
summary: "Get latest logs",
|
|
1597
2046
|
description: "Get the N most recent logs for an environment",
|
|
1598
2047
|
tags: ["environments"],
|
|
1599
2048
|
successDescription: "The latest logs"
|
|
1600
|
-
}).errors({
|
|
1601
|
-
NOT_FOUND: {},
|
|
1602
|
-
BAD_REQUEST: {}
|
|
1603
|
-
}).input(z.object({
|
|
2049
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1604
2050
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1605
2051
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1606
2052
|
level: z.array(z.enum([
|
|
@@ -1610,22 +2056,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1610
2056
|
"DEBUG"
|
|
1611
2057
|
])).optional().describe("Filter by log level"),
|
|
1612
2058
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1613
|
-
})).output(z.object({ logs: z.array(
|
|
1614
|
-
|
|
1615
|
-
type: z.enum([
|
|
1616
|
-
"START",
|
|
1617
|
-
"END",
|
|
1618
|
-
"INFO",
|
|
1619
|
-
"ERROR",
|
|
1620
|
-
"WARNING",
|
|
1621
|
-
"DEBUG"
|
|
1622
|
-
]),
|
|
1623
|
-
requestId: z.string(),
|
|
1624
|
-
content: z.string().optional(),
|
|
1625
|
-
method: z.string().optional(),
|
|
1626
|
-
durationInMs: z.number().optional()
|
|
1627
|
-
})) }));
|
|
1628
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
2059
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
2060
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1629
2061
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1630
2062
|
method: "GET",
|
|
1631
2063
|
summary: "Get deployment logs",
|
|
@@ -1652,22 +2084,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1652
2084
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1653
2085
|
task_count: z.array(analyticsDataPointSchema)
|
|
1654
2086
|
});
|
|
1655
|
-
const getProjectAnalyticsContractV1 =
|
|
2087
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1656
2088
|
path: "/v1/analytics/{projectId}",
|
|
1657
2089
|
method: "GET",
|
|
1658
2090
|
summary: "Get project analytics",
|
|
1659
2091
|
description: "Get analytics data for a project over a time range",
|
|
1660
2092
|
tags: ["analytics"],
|
|
1661
2093
|
successDescription: "The project analytics data"
|
|
1662
|
-
}).errors({
|
|
1663
|
-
NOT_FOUND: {},
|
|
1664
|
-
BAD_REQUEST: {}
|
|
1665
|
-
}).input(z.object({
|
|
2094
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1666
2095
|
projectId: z.string().describe("The ID of the project"),
|
|
1667
2096
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1668
2097
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1669
2098
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1670
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2099
|
+
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 26784e5, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => isValidIanaTimeZone(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
1671
2100
|
metadata: z.object({
|
|
1672
2101
|
startTimestamp: z.number(),
|
|
1673
2102
|
endTimestamp: z.number(),
|
|
@@ -1677,7 +2106,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1677
2106
|
}),
|
|
1678
2107
|
timeSeries: analyticsTimeSeriesSchema
|
|
1679
2108
|
}));
|
|
1680
|
-
const
|
|
2109
|
+
const paginatedInsightsInputShape = {
|
|
2110
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2111
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2112
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2113
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2114
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2115
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2116
|
+
};
|
|
2117
|
+
const listIntentsContractV1 = base.route({
|
|
2118
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2119
|
+
method: "GET",
|
|
2120
|
+
summary: "List intents",
|
|
2121
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2122
|
+
tags: ["insights"],
|
|
2123
|
+
successDescription: "The grouped user intents"
|
|
2124
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2125
|
+
...paginatedInsightsInputShape,
|
|
2126
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2127
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2128
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2129
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2130
|
+
})).output(z.object({
|
|
2131
|
+
intents: z.array(z.object({
|
|
2132
|
+
id: z.string(),
|
|
2133
|
+
intentIds: z.array(z.string()).min(1),
|
|
2134
|
+
environmentId: z.string(),
|
|
2135
|
+
message: z.string(),
|
|
2136
|
+
toolName: z.string(),
|
|
2137
|
+
createdAt: z.coerce.date(),
|
|
2138
|
+
occurrenceCount: z.number().int().positive(),
|
|
2139
|
+
clientName: z.string().nullable(),
|
|
2140
|
+
clientId: z.string().nullable(),
|
|
2141
|
+
categories: z.array(z.object({
|
|
2142
|
+
id: z.string(),
|
|
2143
|
+
name: z.string(),
|
|
2144
|
+
color: intentCategoryColorSchema
|
|
2145
|
+
}))
|
|
2146
|
+
})),
|
|
2147
|
+
totalCount: z.number().int().nonnegative()
|
|
2148
|
+
}));
|
|
2149
|
+
const listFeedbacksContractV1 = base.route({
|
|
2150
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2151
|
+
method: "GET",
|
|
2152
|
+
summary: "List feedbacks",
|
|
2153
|
+
description: "List user feedback for an environment over a time range",
|
|
2154
|
+
tags: ["insights"],
|
|
2155
|
+
successDescription: "The user feedback"
|
|
2156
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2157
|
+
...paginatedInsightsInputShape,
|
|
2158
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2159
|
+
})).output(z.object({
|
|
2160
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2161
|
+
totalCount: z.number().int().nonnegative()
|
|
2162
|
+
}));
|
|
2163
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2164
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2165
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2166
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2167
|
+
method: "GET",
|
|
2168
|
+
summary: "List intent categories",
|
|
2169
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2170
|
+
tags: ["insights"],
|
|
2171
|
+
successDescription: "The intent categories"
|
|
2172
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2173
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2174
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2175
|
+
method: "POST",
|
|
2176
|
+
summary: "Create an intent category",
|
|
2177
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2178
|
+
tags: ["insights"],
|
|
2179
|
+
successDescription: "The created intent category"
|
|
2180
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2181
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2182
|
+
name: intentCategoryNameSchema,
|
|
2183
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2184
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2185
|
+
})).output(intentCategorySchema);
|
|
2186
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2187
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2188
|
+
method: "PATCH",
|
|
2189
|
+
summary: "Update an intent category",
|
|
2190
|
+
description: "Rename or recolor an intent category",
|
|
2191
|
+
tags: ["insights"],
|
|
2192
|
+
successDescription: "The updated intent category"
|
|
2193
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2194
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2195
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2196
|
+
name: intentCategoryNameSchema.optional(),
|
|
2197
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2198
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2199
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2200
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2201
|
+
method: "DELETE",
|
|
2202
|
+
summary: "Delete an intent category",
|
|
2203
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2204
|
+
tags: ["insights"],
|
|
2205
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2206
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2207
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2208
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2209
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2210
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2211
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2212
|
+
method: "POST",
|
|
2213
|
+
summary: "Link an intent category",
|
|
2214
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2215
|
+
tags: ["insights"],
|
|
2216
|
+
successDescription: "The intents have been linked successfully"
|
|
2217
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2218
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2219
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2220
|
+
intentIds: categorizableIntentIdsSchema
|
|
2221
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2222
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2223
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2224
|
+
method: "POST",
|
|
2225
|
+
summary: "Unlink an intent category",
|
|
2226
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2227
|
+
tags: ["insights"],
|
|
2228
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2229
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2230
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2231
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2232
|
+
intentIds: categorizableIntentIdsSchema
|
|
2233
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2234
|
+
const listTeamsContractV1 = base.route({
|
|
1681
2235
|
path: "/v1/teams",
|
|
1682
2236
|
method: "GET",
|
|
1683
2237
|
summary: "List teams",
|
|
@@ -1690,7 +2244,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1690
2244
|
createdAt: z.coerce.date(),
|
|
1691
2245
|
hasStripeAccount: z.boolean()
|
|
1692
2246
|
})));
|
|
1693
|
-
const
|
|
2247
|
+
const getTeamUsageContractV1 = base.route({
|
|
2248
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2249
|
+
method: "GET",
|
|
2250
|
+
summary: "Get team usage",
|
|
2251
|
+
description: "Get the MCP request usage of a team for its current billing window. A team that has made no request in the window reports zero.",
|
|
2252
|
+
tags: ["teams"],
|
|
2253
|
+
successDescription: "The current billing window usage"
|
|
2254
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2255
|
+
teamId: z.string(),
|
|
2256
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2257
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2258
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2259
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2260
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2261
|
+
}));
|
|
2262
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1694
2263
|
path: "/v1/tunnels/ticket",
|
|
1695
2264
|
method: "GET",
|
|
1696
2265
|
summary: "Get a tunnel ticket",
|
|
@@ -1702,16 +2271,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1702
2271
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1703
2272
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1704
2273
|
}));
|
|
1705
|
-
const publishServerContractV1 =
|
|
2274
|
+
const publishServerContractV1 = base.route({
|
|
1706
2275
|
path: "/v1/distribution/publish",
|
|
1707
2276
|
method: "POST",
|
|
1708
2277
|
summary: "Publish a server to the MCP registry",
|
|
1709
2278
|
tags: ["distribution"],
|
|
1710
2279
|
successDescription: "The server has been published successfully"
|
|
1711
|
-
}).errors({
|
|
1712
|
-
NOT_FOUND: {},
|
|
1713
|
-
BAD_REQUEST: {}
|
|
1714
|
-
}).input(z.object({
|
|
2280
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1715
2281
|
projectId: z.string(),
|
|
1716
2282
|
domain: z.string(),
|
|
1717
2283
|
title: z.string().min(1).max(100),
|
|
@@ -1720,17 +2286,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1720
2286
|
iconSrc: z.url().max(255).optional(),
|
|
1721
2287
|
dryRun: z.boolean().optional()
|
|
1722
2288
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1723
|
-
const getServerInfoContractV1 =
|
|
2289
|
+
const getServerInfoContractV1 = base.route({
|
|
1724
2290
|
path: "/v1/distribution/get",
|
|
1725
2291
|
method: "GET",
|
|
1726
2292
|
summary: "Get server info",
|
|
1727
2293
|
description: "Get info about a server",
|
|
1728
2294
|
tags: ["distribution"],
|
|
1729
2295
|
successDescription: "The server info"
|
|
1730
|
-
}).errors({
|
|
1731
|
-
NOT_FOUND: {},
|
|
1732
|
-
BAD_REQUEST: {}
|
|
1733
|
-
}).input(z.object({
|
|
2296
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1734
2297
|
projectId: z.string(),
|
|
1735
2298
|
domain: z.string()
|
|
1736
2299
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1749,7 +2312,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1749
2312
|
isPlaygroundEnabled: z.boolean(),
|
|
1750
2313
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1751
2314
|
});
|
|
1752
|
-
const getPlaygroundContractV1 =
|
|
2315
|
+
const getPlaygroundContractV1 = base.route({
|
|
1753
2316
|
path: "/v1/environments/{environmentId}/playground",
|
|
1754
2317
|
method: "GET",
|
|
1755
2318
|
summary: "Get playground configuration",
|
|
@@ -1757,17 +2320,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1757
2320
|
tags: ["environments"],
|
|
1758
2321
|
successDescription: "The playground configuration"
|
|
1759
2322
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1760
|
-
const upsertPlaygroundContractV1 =
|
|
2323
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1761
2324
|
path: "/v1/environments/{environmentId}/playground",
|
|
1762
2325
|
method: "PUT",
|
|
1763
2326
|
summary: "Update playground configuration",
|
|
1764
2327
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1765
2328
|
tags: ["environments"],
|
|
1766
2329
|
successDescription: "The updated playground configuration"
|
|
1767
|
-
}).errors({
|
|
1768
|
-
NOT_FOUND: {},
|
|
1769
|
-
BAD_REQUEST: {}
|
|
1770
|
-
}).input(z.object({
|
|
2330
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1771
2331
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1772
2332
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1773
2333
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1775,7 +2335,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1775
2335
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1776
2336
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1777
2337
|
})).output(playgroundOutputSchema);
|
|
1778
|
-
const createBeaconContractV1 =
|
|
2338
|
+
const createBeaconContractV1 = base.route({
|
|
1779
2339
|
path: "/v1/beacon/audits",
|
|
1780
2340
|
method: "POST",
|
|
1781
2341
|
summary: "Create a beacon audit",
|
|
@@ -1784,7 +2344,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1784
2344
|
successDescription: "The audit has been created"
|
|
1785
2345
|
}).errors({
|
|
1786
2346
|
NOT_FOUND: {},
|
|
1787
|
-
BAD_REQUEST: {},
|
|
1788
2347
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1789
2348
|
}).input(z.object({
|
|
1790
2349
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1792,7 +2351,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1792
2351
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1793
2352
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1794
2353
|
})).output(z.object({ id: z.string() }));
|
|
1795
|
-
const getBeaconContractV1 =
|
|
2354
|
+
const getBeaconContractV1 = base.route({
|
|
1796
2355
|
path: "/v1/beacon/audits/{auditId}",
|
|
1797
2356
|
method: "GET",
|
|
1798
2357
|
summary: "Get a beacon audit",
|
|
@@ -1807,9 +2366,61 @@ const getBeaconContractV1 = oc.route({
|
|
|
1807
2366
|
createdAt: z.coerce.date(),
|
|
1808
2367
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1809
2368
|
}));
|
|
2369
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2370
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2371
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2372
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2373
|
+
const createSubmissionContractV1 = base.route({
|
|
2374
|
+
path: "/v1/submissions",
|
|
2375
|
+
method: "POST",
|
|
2376
|
+
summary: "Create a submission package",
|
|
2377
|
+
description: "Create a submission package for an environment. Alpic reads the environment's live MCP server and prefills every field it can infer, so the response already carries the populated package. The environment must have a successful deployment and must not require authentication.",
|
|
2378
|
+
tags: ["submissions"],
|
|
2379
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2380
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2381
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2382
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2383
|
+
})).output(submissionSchema);
|
|
2384
|
+
const getSubmissionContractV1 = base.route({
|
|
2385
|
+
path: "/v1/submissions/{submissionId}",
|
|
2386
|
+
method: "GET",
|
|
2387
|
+
summary: "Get a submission package",
|
|
2388
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2389
|
+
tags: ["submissions"],
|
|
2390
|
+
successDescription: "The submission package"
|
|
2391
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2392
|
+
const updateSubmissionContractV1 = base.route({
|
|
2393
|
+
path: "/v1/submissions/{submissionId}",
|
|
2394
|
+
method: "PUT",
|
|
2395
|
+
summary: "Update a submission package",
|
|
2396
|
+
description: "Update the form data of a submission package. Only the fields you send are changed; the rest are left as they are. Unknown field names are rejected rather than ignored, so a typo fails the call. `platform` must match the package's own platform.",
|
|
2397
|
+
tags: ["submissions"],
|
|
2398
|
+
successDescription: "The updated submission package"
|
|
2399
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2400
|
+
submissionId: submissionIdSchema,
|
|
2401
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2402
|
+
formData: claudeSubmissionUpdateSchema
|
|
2403
|
+
}), z.object({
|
|
2404
|
+
submissionId: submissionIdSchema,
|
|
2405
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2406
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2407
|
+
})])).output(submissionSchema);
|
|
1810
2408
|
const contract = {
|
|
1811
|
-
teams: {
|
|
2409
|
+
teams: {
|
|
2410
|
+
list: { v1: listTeamsContractV1 },
|
|
2411
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2412
|
+
},
|
|
1812
2413
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2414
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2415
|
+
intentCategories: {
|
|
2416
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2417
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2418
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2419
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2420
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2421
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2422
|
+
},
|
|
2423
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1813
2424
|
deployments: {
|
|
1814
2425
|
list: { v1: listDeploymentsContractV1 },
|
|
1815
2426
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1819,6 +2430,7 @@ const contract = {
|
|
|
1819
2430
|
environments: {
|
|
1820
2431
|
create: { v1: createEnvironmentContractV1 },
|
|
1821
2432
|
get: { v1: getEnvironmentContractV1 },
|
|
2433
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1822
2434
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1823
2435
|
getLogs: { v1: getLogsContractV1 },
|
|
1824
2436
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1848,7 +2460,38 @@ const contract = {
|
|
|
1848
2460
|
beacon: {
|
|
1849
2461
|
create: { v1: createBeaconContractV1 },
|
|
1850
2462
|
get: { v1: getBeaconContractV1 }
|
|
2463
|
+
},
|
|
2464
|
+
submissions: {
|
|
2465
|
+
create: { v1: createSubmissionContractV1 },
|
|
2466
|
+
get: { v1: getSubmissionContractV1 },
|
|
2467
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2468
|
+
}
|
|
2469
|
+
};
|
|
2470
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2471
|
+
const contractForDocs = {
|
|
2472
|
+
...contract,
|
|
2473
|
+
deployments: deploymentsForDocs
|
|
2474
|
+
};
|
|
2475
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2476
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2477
|
+
info: {
|
|
2478
|
+
title: "Alpic API",
|
|
2479
|
+
version: "1.0.0"
|
|
2480
|
+
},
|
|
2481
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2482
|
+
security: [{ bearerAuth: [] }],
|
|
2483
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2484
|
+
type: "http",
|
|
2485
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2486
|
+
scheme: "bearer"
|
|
2487
|
+
} } },
|
|
2488
|
+
commonSchemas: {
|
|
2489
|
+
Submission: { schema: submissionSchema },
|
|
2490
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2491
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2492
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2493
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
1851
2494
|
}
|
|
1852
2495
|
};
|
|
1853
2496
|
//#endregion
|
|
1854
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2497
|
+
export { AI_PLATFORMS, AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, OPENAPI_DOC_OPTIONS, PLATFORM_LABELS, buildSettingsSchema, chatgptSubmissionUpdateSchema, claudeSubmissionUpdateSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|