@alpic-ai/api 0.0.0-dev.gd79770d → 0.0.0-dev.gd7a6f1d
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 +1545 -58
- package/dist/index.mjs +694 -210
- 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.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",
|
|
@@ -565,15 +856,7 @@ z.object({
|
|
|
565
856
|
serverFields: serverFieldsSchema$1,
|
|
566
857
|
source: z.enum(["registry", "defaults"])
|
|
567
858
|
});
|
|
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
|
-
*/
|
|
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. */
|
|
577
860
|
const clampStringField = (field) => {
|
|
578
861
|
const max = field.maxLength;
|
|
579
862
|
if (max === null) return field;
|
|
@@ -593,11 +876,19 @@ const toolDefinitionSchema = z.object({
|
|
|
593
876
|
}).optional()
|
|
594
877
|
});
|
|
595
878
|
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."),
|
|
879
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
880
|
+
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
881
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
599
882
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
600
|
-
}).
|
|
883
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
884
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial();
|
|
885
|
+
const blankPositiveTestCase = () => ({
|
|
886
|
+
scenario: "",
|
|
887
|
+
userPrompt: "",
|
|
888
|
+
toolTriggered: "",
|
|
889
|
+
expectedOutput: ""
|
|
890
|
+
});
|
|
891
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
601
892
|
const screenshotEntrySchema = z.object({
|
|
602
893
|
prompt: z.string(),
|
|
603
894
|
url: z.url()
|
|
@@ -910,20 +1201,21 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
910
1201
|
"zh-TW"
|
|
911
1202
|
]);
|
|
912
1203
|
const negativeTestCaseSchema = z.object({
|
|
913
|
-
scenario: z.string(),
|
|
914
|
-
userPrompt: z.string()
|
|
915
|
-
}).
|
|
1204
|
+
scenario: z.string().min(1),
|
|
1205
|
+
userPrompt: z.string().min(1)
|
|
1206
|
+
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1207
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial();
|
|
1208
|
+
const blankNegativeTestCase = () => ({
|
|
1209
|
+
scenario: "",
|
|
1210
|
+
userPrompt: ""
|
|
1211
|
+
});
|
|
916
1212
|
const chatgptToolJustificationSchema = z.object({
|
|
917
1213
|
toolName: z.string(),
|
|
918
1214
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
919
1215
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
920
1216
|
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
1217
|
}).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
|
-
*/
|
|
1218
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
927
1219
|
const chatgptTaglineSchema = z.string().max(30);
|
|
928
1220
|
const chatgptDescriptionSchema = z.string();
|
|
929
1221
|
const chatgptTranslationSchema = z.object({
|
|
@@ -932,10 +1224,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
932
1224
|
description: chatgptDescriptionSchema
|
|
933
1225
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
934
1226
|
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
|
-
*/
|
|
1227
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
939
1228
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
940
1229
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
941
1230
|
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."),
|
|
@@ -954,8 +1243,8 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
954
1243
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
955
1244
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
956
1245
|
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
|
-
testCases: z.array(positiveTestCaseSchema).describe("
|
|
958
|
-
negativeTestCases: z.array(negativeTestCaseSchema).describe("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."),
|
|
1246
|
+
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."),
|
|
1247
|
+
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."),
|
|
959
1248
|
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."),
|
|
960
1249
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
961
1250
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
@@ -970,23 +1259,31 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
970
1259
|
demoRecordingUrl: z.string().optional(),
|
|
971
1260
|
serverUrl: z.string().optional(),
|
|
972
1261
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1262
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1263
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
973
1264
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
974
1265
|
});
|
|
975
|
-
|
|
1266
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1267
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
976
1268
|
appName: true,
|
|
977
1269
|
developerName: true,
|
|
978
1270
|
serverUrl: true,
|
|
979
1271
|
tools: true,
|
|
980
1272
|
authentication: true
|
|
981
1273
|
});
|
|
982
|
-
|
|
1274
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1275
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
983
1276
|
tagline: true,
|
|
984
1277
|
description: true,
|
|
985
1278
|
category: true,
|
|
986
1279
|
testCases: true,
|
|
987
1280
|
negativeTestCases: true,
|
|
988
1281
|
toolJustifications: true
|
|
989
|
-
}).extend({
|
|
1282
|
+
}).extend({
|
|
1283
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1284
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1285
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1286
|
+
});
|
|
990
1287
|
const claudeCategorySchema = z.enum([
|
|
991
1288
|
"Productivity",
|
|
992
1289
|
"Communication",
|
|
@@ -1032,11 +1329,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1032
1329
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1033
1330
|
"Public documentation for this connector will be live by the publish date."
|
|
1034
1331
|
]);
|
|
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
|
-
*/
|
|
1332
|
+
/** 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
1333
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1041
1334
|
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
1335
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1113,7 +1406,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1113
1406
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1114
1407
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1115
1408
|
});
|
|
1116
|
-
|
|
1409
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1410
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1117
1411
|
serverUrl: true,
|
|
1118
1412
|
name: true,
|
|
1119
1413
|
slug: true,
|
|
@@ -1128,22 +1422,24 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1128
1422
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1129
1423
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1130
1424
|
});
|
|
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
|
-
*/
|
|
1425
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1137
1426
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1138
1427
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1139
1428
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1140
1429
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1141
1430
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1142
1431
|
});
|
|
1143
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1432
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1144
1433
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1145
1434
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1146
1435
|
});
|
|
1436
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1437
|
+
const byField = {};
|
|
1438
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1439
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1440
|
+
return byField;
|
|
1441
|
+
}
|
|
1442
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1147
1443
|
const submissionMetaFieldsSchema = z.object({
|
|
1148
1444
|
id: z.string(),
|
|
1149
1445
|
environmentId: z.string(),
|
|
@@ -1153,14 +1449,21 @@ const submissionMetaFieldsSchema = z.object({
|
|
|
1153
1449
|
});
|
|
1154
1450
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1155
1451
|
platform: z.literal("claudeai"),
|
|
1156
|
-
formData: claudeSubmissionDraftSchema
|
|
1452
|
+
formData: claudeSubmissionDraftSchema,
|
|
1453
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1157
1454
|
});
|
|
1158
1455
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1159
1456
|
platform: z.literal("chatgpt"),
|
|
1160
|
-
formData: chatgptSubmissionDraftSchema
|
|
1457
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1458
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1161
1459
|
});
|
|
1162
1460
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1163
1461
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1462
|
+
z.literal([
|
|
1463
|
+
100,
|
|
1464
|
+
75,
|
|
1465
|
+
50
|
|
1466
|
+
]);
|
|
1164
1467
|
const subscriptionPlanSchema = z.enum([
|
|
1165
1468
|
"pro",
|
|
1166
1469
|
"business",
|
|
@@ -1172,17 +1475,70 @@ const customerCreditsSchema = z.object({
|
|
|
1172
1475
|
expiresAt: z.number().nullable(),
|
|
1173
1476
|
currency: z.string()
|
|
1174
1477
|
});
|
|
1175
|
-
const customerUsageSchema = z.object({
|
|
1176
|
-
amountInCents: z.number(),
|
|
1177
|
-
currency: z.string(),
|
|
1178
|
-
periodEnd: z.number()
|
|
1179
|
-
});
|
|
1180
1478
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1181
1479
|
z.object({
|
|
1182
1480
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1183
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1184
1481
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1185
1482
|
});
|
|
1483
|
+
const metricsQueueEventSchema = z.object({
|
|
1484
|
+
ts: z.number().int(),
|
|
1485
|
+
method: z.string(),
|
|
1486
|
+
tool: z.string().nullable(),
|
|
1487
|
+
client: z.string(),
|
|
1488
|
+
sessionId: z.string().nullable(),
|
|
1489
|
+
durationMs: z.number().int(),
|
|
1490
|
+
outputTokens: z.number().int().nullable(),
|
|
1491
|
+
errorType: z.enum([
|
|
1492
|
+
"mcp_error",
|
|
1493
|
+
"tool_error",
|
|
1494
|
+
"timeout"
|
|
1495
|
+
]).nullable(),
|
|
1496
|
+
errorCode: z.number().int().nullable()
|
|
1497
|
+
});
|
|
1498
|
+
z.object({
|
|
1499
|
+
v: z.literal(1),
|
|
1500
|
+
envId: z.string(),
|
|
1501
|
+
events: z.array(metricsQueueEventSchema)
|
|
1502
|
+
});
|
|
1503
|
+
z.object({ v: z.number() });
|
|
1504
|
+
const telemetrySignalSchema = z.enum([
|
|
1505
|
+
"logs",
|
|
1506
|
+
"metrics",
|
|
1507
|
+
"traces"
|
|
1508
|
+
]);
|
|
1509
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1510
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1511
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1512
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1513
|
+
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");
|
|
1514
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1515
|
+
id: z.string(),
|
|
1516
|
+
name: otlpHeaderNameSchema,
|
|
1517
|
+
value: otlpHeaderValueSchema,
|
|
1518
|
+
isSecret: z.boolean()
|
|
1519
|
+
});
|
|
1520
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1521
|
+
"credentials",
|
|
1522
|
+
"wrong-path",
|
|
1523
|
+
"wrong-protocol",
|
|
1524
|
+
"invalid-payload",
|
|
1525
|
+
"partial-rejection",
|
|
1526
|
+
"blocked-target",
|
|
1527
|
+
"timeout",
|
|
1528
|
+
"unreachable",
|
|
1529
|
+
"receiver-error",
|
|
1530
|
+
"unexpected-status"
|
|
1531
|
+
]);
|
|
1532
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1533
|
+
z.object({
|
|
1534
|
+
id: z.string(),
|
|
1535
|
+
signal: telemetrySignalSchema,
|
|
1536
|
+
endpoint: otlpEndpointSchema,
|
|
1537
|
+
protocol: otlpProtocolSchema,
|
|
1538
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1539
|
+
status: telemetryDestinationStatusSchema,
|
|
1540
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1541
|
+
});
|
|
1186
1542
|
//#endregion
|
|
1187
1543
|
//#region src/auth-scope.ts
|
|
1188
1544
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1225,7 +1581,10 @@ const RESERVED_KEYS = [
|
|
|
1225
1581
|
"BUILD_ARG_START_COMMAND",
|
|
1226
1582
|
"ALPIC_HOST",
|
|
1227
1583
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1228
|
-
"ALPIC_INTENT_META_KEY"
|
|
1584
|
+
"ALPIC_INTENT_META_KEY",
|
|
1585
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1586
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1587
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1229
1588
|
];
|
|
1230
1589
|
const environmentVariableSchema = z.object({
|
|
1231
1590
|
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 +1637,14 @@ const serverFieldsSchema = z.object({
|
|
|
1278
1637
|
});
|
|
1279
1638
|
//#endregion
|
|
1280
1639
|
//#region src/api.contract.ts
|
|
1640
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1641
|
+
try {
|
|
1642
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1643
|
+
return true;
|
|
1644
|
+
} catch {
|
|
1645
|
+
return false;
|
|
1646
|
+
}
|
|
1647
|
+
};
|
|
1281
1648
|
const deploymentStatusSchema = z.enum([
|
|
1282
1649
|
"ongoing",
|
|
1283
1650
|
"deployed",
|
|
@@ -1306,21 +1673,20 @@ const deploymentSchema = z.object({
|
|
|
1306
1673
|
isCurrent: z.boolean(),
|
|
1307
1674
|
deploymentPageUrl: z.url().nullable()
|
|
1308
1675
|
});
|
|
1309
|
-
const
|
|
1676
|
+
const isValidTimeInput = (value) => {
|
|
1310
1677
|
if (ms(value) !== void 0) return true;
|
|
1311
1678
|
return !Number.isNaN(new Date(value).getTime());
|
|
1312
1679
|
};
|
|
1313
|
-
const
|
|
1680
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1681
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1682
|
+
const createEnvironmentContractV1 = base.route({
|
|
1314
1683
|
path: "/v1/environments",
|
|
1315
1684
|
method: "POST",
|
|
1316
1685
|
summary: "Create an environment",
|
|
1317
1686
|
description: "Create an environment for a project",
|
|
1318
1687
|
tags: ["environments"],
|
|
1319
1688
|
successDescription: "The environment has been created successfully"
|
|
1320
|
-
}).errors({
|
|
1321
|
-
NOT_FOUND: {},
|
|
1322
|
-
BAD_REQUEST: {}
|
|
1323
|
-
}).input(z.object({
|
|
1689
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1324
1690
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1325
1691
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1326
1692
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1333,7 +1699,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1333
1699
|
createdAt: z.coerce.date(),
|
|
1334
1700
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1335
1701
|
}));
|
|
1336
|
-
const getEnvironmentContractV1 =
|
|
1702
|
+
const getEnvironmentContractV1 = base.route({
|
|
1337
1703
|
path: "/v1/environments/{environmentId}",
|
|
1338
1704
|
method: "GET",
|
|
1339
1705
|
summary: "Get an environment",
|
|
@@ -1349,6 +1715,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1349
1715
|
createdAt: z.coerce.date(),
|
|
1350
1716
|
projectId: z.string()
|
|
1351
1717
|
}));
|
|
1718
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1719
|
+
path: "/v1/environments/{environmentId}",
|
|
1720
|
+
method: "DELETE",
|
|
1721
|
+
summary: "Delete an environment",
|
|
1722
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1723
|
+
tags: ["environments"],
|
|
1724
|
+
successDescription: "The environment has been deleted successfully"
|
|
1725
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1352
1726
|
const domainSchema = z.object({
|
|
1353
1727
|
domain: z.string(),
|
|
1354
1728
|
status: z.enum([
|
|
@@ -1390,7 +1764,7 @@ const projectOutputSchema = z.object({
|
|
|
1390
1764
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1391
1765
|
environments: z.array(environmentSchema)
|
|
1392
1766
|
});
|
|
1393
|
-
const getProjectContractV1 =
|
|
1767
|
+
const getProjectContractV1 = base.route({
|
|
1394
1768
|
path: "/v1/projects/{projectId}",
|
|
1395
1769
|
method: "GET",
|
|
1396
1770
|
summary: "Get a project",
|
|
@@ -1398,18 +1772,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1398
1772
|
tags: ["projects"],
|
|
1399
1773
|
successDescription: "The project details"
|
|
1400
1774
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1401
|
-
const listProjectsContractV1 =
|
|
1775
|
+
const listProjectsContractV1 = base.route({
|
|
1402
1776
|
path: "/v1/projects",
|
|
1403
1777
|
method: "GET",
|
|
1404
1778
|
summary: "List projects",
|
|
1405
1779
|
description: "List all projects for a team",
|
|
1406
1780
|
tags: ["projects"],
|
|
1407
1781
|
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({
|
|
1782
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1783
|
+
const createProjectContractV1 = base.route({
|
|
1413
1784
|
path: "/v1/projects",
|
|
1414
1785
|
method: "POST",
|
|
1415
1786
|
summary: "Create a project",
|
|
@@ -1418,7 +1789,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1418
1789
|
successDescription: "The project has been created successfully"
|
|
1419
1790
|
}).errors({
|
|
1420
1791
|
NOT_FOUND: {},
|
|
1421
|
-
BAD_REQUEST: {},
|
|
1422
1792
|
FORBIDDEN: {}
|
|
1423
1793
|
}).input(z.object({
|
|
1424
1794
|
teamId: z.string().optional(),
|
|
@@ -1459,7 +1829,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1459
1829
|
isSecret: z.boolean(),
|
|
1460
1830
|
createdAt: z.coerce.date()
|
|
1461
1831
|
});
|
|
1462
|
-
const listEnvironmentVariablesContractV1 =
|
|
1832
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1463
1833
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1464
1834
|
method: "GET",
|
|
1465
1835
|
summary: "List environment variables",
|
|
@@ -1467,48 +1837,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1467
1837
|
tags: ["environments"],
|
|
1468
1838
|
successDescription: "The list of environment variables"
|
|
1469
1839
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1470
|
-
const createEnvironmentVariablesContractV1 =
|
|
1840
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1471
1841
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1472
1842
|
method: "POST",
|
|
1473
1843
|
summary: "Add environment variables",
|
|
1474
1844
|
description: "Add one or more environment variables to an environment",
|
|
1475
1845
|
tags: ["environments"],
|
|
1476
1846
|
successDescription: "The environment variables have been added successfully"
|
|
1477
|
-
}).errors({
|
|
1478
|
-
NOT_FOUND: {},
|
|
1479
|
-
BAD_REQUEST: {}
|
|
1480
|
-
}).input(z.object({
|
|
1847
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1481
1848
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1482
1849
|
environmentVariables: environmentVariablesSchema
|
|
1483
1850
|
})).output(z.object({ success: z.literal(true) }));
|
|
1484
|
-
const updateEnvironmentVariableContractV1 =
|
|
1851
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1485
1852
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1486
1853
|
method: "PATCH",
|
|
1487
1854
|
summary: "Update an environment variable",
|
|
1488
1855
|
description: "Update an environment variable by ID",
|
|
1489
1856
|
tags: ["environments"],
|
|
1490
1857
|
successDescription: "The environment variable has been updated successfully"
|
|
1491
|
-
}).errors({
|
|
1492
|
-
NOT_FOUND: {},
|
|
1493
|
-
BAD_REQUEST: {}
|
|
1494
|
-
}).input(z.object({
|
|
1858
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1495
1859
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1496
1860
|
key: environmentVariableSchema.shape.key,
|
|
1497
1861
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1498
1862
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1499
1863
|
})).output(z.object({ success: z.literal(true) }));
|
|
1500
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1864
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1501
1865
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1502
1866
|
method: "DELETE",
|
|
1503
1867
|
summary: "Delete an environment variable",
|
|
1504
1868
|
description: "Delete an environment variable by ID",
|
|
1505
1869
|
tags: ["environments"],
|
|
1506
1870
|
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({
|
|
1871
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1872
|
+
const deleteProjectContractV1 = base.route({
|
|
1512
1873
|
path: "/v1/projects/{projectId}",
|
|
1513
1874
|
method: "DELETE",
|
|
1514
1875
|
summary: "Delete a project",
|
|
@@ -1516,7 +1877,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1516
1877
|
tags: ["projects"],
|
|
1517
1878
|
successDescription: "The project has been deleted successfully"
|
|
1518
1879
|
}).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 =
|
|
1880
|
+
const updateProjectContractV1 = base.route({
|
|
1520
1881
|
path: "/v1/projects/{projectId}",
|
|
1521
1882
|
method: "PATCH",
|
|
1522
1883
|
summary: "Update a project",
|
|
@@ -1525,14 +1886,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1525
1886
|
successDescription: "The project has been updated successfully"
|
|
1526
1887
|
}).errors({
|
|
1527
1888
|
NOT_FOUND: {},
|
|
1528
|
-
BAD_REQUEST: {},
|
|
1529
1889
|
FORBIDDEN: {}
|
|
1530
1890
|
}).input(z.object({
|
|
1531
1891
|
projectId: z.string().describe("The ID of the project"),
|
|
1532
1892
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1533
1893
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1534
1894
|
})).output(projectOutputSchema);
|
|
1535
|
-
const deployEnvironmentContractV1 =
|
|
1895
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1536
1896
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1537
1897
|
method: "POST",
|
|
1538
1898
|
summary: "Deploy an environment",
|
|
@@ -1541,28 +1901,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1541
1901
|
successDescription: "The environment has been deployed successfully"
|
|
1542
1902
|
}).errors({
|
|
1543
1903
|
NOT_FOUND: {},
|
|
1544
|
-
|
|
1904
|
+
CONFLICT: {}
|
|
1545
1905
|
}).input(z.object({
|
|
1546
1906
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1547
1907
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1548
1908
|
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
1909
|
})).output(deploymentSchema);
|
|
1550
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1910
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1551
1911
|
path: "/v1/deployments/upload",
|
|
1552
1912
|
method: "POST",
|
|
1553
1913
|
summary: "Upload deployment artifacts",
|
|
1554
1914
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1555
1915
|
tags: ["deployments"],
|
|
1556
1916
|
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({
|
|
1917
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1561
1918
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1562
1919
|
token: z.string().describe("Token to identify the source archive"),
|
|
1563
1920
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1564
1921
|
}));
|
|
1565
|
-
const listDeploymentsContractV1 =
|
|
1922
|
+
const listDeploymentsContractV1 = base.route({
|
|
1566
1923
|
path: "/v1/projects/{projectId}/deployments",
|
|
1567
1924
|
method: "GET",
|
|
1568
1925
|
summary: "List project deployments",
|
|
@@ -1574,7 +1931,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1574
1931
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1575
1932
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1576
1933
|
})).output(z.array(deploymentSchema));
|
|
1577
|
-
const getDeploymentContractV1 =
|
|
1934
|
+
const getDeploymentContractV1 = base.route({
|
|
1578
1935
|
path: "/v1/deployments/{deploymentId}",
|
|
1579
1936
|
method: "GET",
|
|
1580
1937
|
summary: "Get a deployment",
|
|
@@ -1582,20 +1939,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1582
1939
|
tags: ["deployments"],
|
|
1583
1940
|
successDescription: "The deployment details"
|
|
1584
1941
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1585
|
-
const
|
|
1942
|
+
const logEntrySchema = z.object({
|
|
1943
|
+
timestamp: z.coerce.date(),
|
|
1944
|
+
type: z.enum([
|
|
1945
|
+
"START",
|
|
1946
|
+
"END",
|
|
1947
|
+
"INFO",
|
|
1948
|
+
"ERROR",
|
|
1949
|
+
"WARNING",
|
|
1950
|
+
"DEBUG"
|
|
1951
|
+
]),
|
|
1952
|
+
requestId: z.string(),
|
|
1953
|
+
content: z.string().optional(),
|
|
1954
|
+
method: z.string().optional(),
|
|
1955
|
+
durationInMs: z.number().optional()
|
|
1956
|
+
});
|
|
1957
|
+
const getLogsContractV1 = base.route({
|
|
1586
1958
|
path: "/v1/environments/{environmentId}/logs",
|
|
1587
1959
|
method: "GET",
|
|
1588
1960
|
summary: "Get logs",
|
|
1589
1961
|
description: "Get logs for an environment",
|
|
1590
1962
|
tags: ["environments"],
|
|
1591
1963
|
successDescription: "The logs"
|
|
1592
|
-
}).errors({
|
|
1593
|
-
NOT_FOUND: {},
|
|
1594
|
-
BAD_REQUEST: {}
|
|
1595
|
-
}).input(z.object({
|
|
1964
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1596
1965
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1597
|
-
since:
|
|
1598
|
-
until:
|
|
1966
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1967
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1599
1968
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1600
1969
|
level: z.array(z.enum([
|
|
1601
1970
|
"INFO",
|
|
@@ -1606,34 +1975,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1606
1975
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1607
1976
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1608
1977
|
})).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
|
-
})),
|
|
1978
|
+
logs: z.array(logEntrySchema),
|
|
1624
1979
|
nextToken: z.string().nullable()
|
|
1625
1980
|
}));
|
|
1626
|
-
const getLatestLogsContractV1 =
|
|
1981
|
+
const getLatestLogsContractV1 = base.route({
|
|
1627
1982
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1628
1983
|
method: "GET",
|
|
1629
1984
|
summary: "Get latest logs",
|
|
1630
1985
|
description: "Get the N most recent logs for an environment",
|
|
1631
1986
|
tags: ["environments"],
|
|
1632
1987
|
successDescription: "The latest logs"
|
|
1633
|
-
}).errors({
|
|
1634
|
-
NOT_FOUND: {},
|
|
1635
|
-
BAD_REQUEST: {}
|
|
1636
|
-
}).input(z.object({
|
|
1988
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1637
1989
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1638
1990
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1639
1991
|
level: z.array(z.enum([
|
|
@@ -1643,22 +1995,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1643
1995
|
"DEBUG"
|
|
1644
1996
|
])).optional().describe("Filter by log level"),
|
|
1645
1997
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
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({
|
|
1998
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1999
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1662
2000
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1663
2001
|
method: "GET",
|
|
1664
2002
|
summary: "Get deployment logs",
|
|
@@ -1685,22 +2023,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1685
2023
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1686
2024
|
task_count: z.array(analyticsDataPointSchema)
|
|
1687
2025
|
});
|
|
1688
|
-
const getProjectAnalyticsContractV1 =
|
|
2026
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1689
2027
|
path: "/v1/analytics/{projectId}",
|
|
1690
2028
|
method: "GET",
|
|
1691
2029
|
summary: "Get project analytics",
|
|
1692
2030
|
description: "Get analytics data for a project over a time range",
|
|
1693
2031
|
tags: ["analytics"],
|
|
1694
2032
|
successDescription: "The project analytics data"
|
|
1695
|
-
}).errors({
|
|
1696
|
-
NOT_FOUND: {},
|
|
1697
|
-
BAD_REQUEST: {}
|
|
1698
|
-
}).input(z.object({
|
|
2033
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1699
2034
|
projectId: z.string().describe("The ID of the project"),
|
|
1700
2035
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1701
2036
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1702
2037
|
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 <=
|
|
2038
|
+
}).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
2039
|
metadata: z.object({
|
|
1705
2040
|
startTimestamp: z.number(),
|
|
1706
2041
|
endTimestamp: z.number(),
|
|
@@ -1710,7 +2045,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1710
2045
|
}),
|
|
1711
2046
|
timeSeries: analyticsTimeSeriesSchema
|
|
1712
2047
|
}));
|
|
1713
|
-
const
|
|
2048
|
+
const paginatedInsightsInputShape = {
|
|
2049
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2050
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2051
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2052
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2053
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2054
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2055
|
+
};
|
|
2056
|
+
const listIntentsContractV1 = base.route({
|
|
2057
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2058
|
+
method: "GET",
|
|
2059
|
+
summary: "List intents",
|
|
2060
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2061
|
+
tags: ["insights"],
|
|
2062
|
+
successDescription: "The grouped user intents"
|
|
2063
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2064
|
+
...paginatedInsightsInputShape,
|
|
2065
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2066
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2067
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2068
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2069
|
+
})).output(z.object({
|
|
2070
|
+
intents: z.array(z.object({
|
|
2071
|
+
id: z.string(),
|
|
2072
|
+
intentIds: z.array(z.string()).min(1),
|
|
2073
|
+
environmentId: z.string(),
|
|
2074
|
+
message: z.string(),
|
|
2075
|
+
toolName: z.string(),
|
|
2076
|
+
createdAt: z.coerce.date(),
|
|
2077
|
+
occurrenceCount: z.number().int().positive(),
|
|
2078
|
+
clientName: z.string().nullable(),
|
|
2079
|
+
clientId: z.string().nullable(),
|
|
2080
|
+
categories: z.array(z.object({
|
|
2081
|
+
id: z.string(),
|
|
2082
|
+
name: z.string(),
|
|
2083
|
+
color: intentCategoryColorSchema
|
|
2084
|
+
}))
|
|
2085
|
+
})),
|
|
2086
|
+
totalCount: z.number().int().nonnegative()
|
|
2087
|
+
}));
|
|
2088
|
+
const listFeedbacksContractV1 = base.route({
|
|
2089
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2090
|
+
method: "GET",
|
|
2091
|
+
summary: "List feedbacks",
|
|
2092
|
+
description: "List user feedback for an environment over a time range",
|
|
2093
|
+
tags: ["insights"],
|
|
2094
|
+
successDescription: "The user feedback"
|
|
2095
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2096
|
+
...paginatedInsightsInputShape,
|
|
2097
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2098
|
+
})).output(z.object({
|
|
2099
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2100
|
+
totalCount: z.number().int().nonnegative()
|
|
2101
|
+
}));
|
|
2102
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2103
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2104
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2105
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2106
|
+
method: "GET",
|
|
2107
|
+
summary: "List intent categories",
|
|
2108
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2109
|
+
tags: ["insights"],
|
|
2110
|
+
successDescription: "The intent categories"
|
|
2111
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2112
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2113
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2114
|
+
method: "POST",
|
|
2115
|
+
summary: "Create an intent category",
|
|
2116
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2117
|
+
tags: ["insights"],
|
|
2118
|
+
successDescription: "The created intent category"
|
|
2119
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2120
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2121
|
+
name: intentCategoryNameSchema,
|
|
2122
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2123
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2124
|
+
})).output(intentCategorySchema);
|
|
2125
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2126
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2127
|
+
method: "PATCH",
|
|
2128
|
+
summary: "Update an intent category",
|
|
2129
|
+
description: "Rename or recolor an intent category",
|
|
2130
|
+
tags: ["insights"],
|
|
2131
|
+
successDescription: "The updated intent category"
|
|
2132
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2133
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2134
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2135
|
+
name: intentCategoryNameSchema.optional(),
|
|
2136
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2137
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2138
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2139
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2140
|
+
method: "DELETE",
|
|
2141
|
+
summary: "Delete an intent category",
|
|
2142
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2143
|
+
tags: ["insights"],
|
|
2144
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2145
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2146
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2147
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2148
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2149
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2150
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2151
|
+
method: "POST",
|
|
2152
|
+
summary: "Link an intent category",
|
|
2153
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2154
|
+
tags: ["insights"],
|
|
2155
|
+
successDescription: "The intents have been linked successfully"
|
|
2156
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2157
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2158
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2159
|
+
intentIds: categorizableIntentIdsSchema
|
|
2160
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2161
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2162
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2163
|
+
method: "POST",
|
|
2164
|
+
summary: "Unlink an intent category",
|
|
2165
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2166
|
+
tags: ["insights"],
|
|
2167
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2168
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2169
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2170
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2171
|
+
intentIds: categorizableIntentIdsSchema
|
|
2172
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2173
|
+
const listTeamsContractV1 = base.route({
|
|
1714
2174
|
path: "/v1/teams",
|
|
1715
2175
|
method: "GET",
|
|
1716
2176
|
summary: "List teams",
|
|
@@ -1723,7 +2183,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1723
2183
|
createdAt: z.coerce.date(),
|
|
1724
2184
|
hasStripeAccount: z.boolean()
|
|
1725
2185
|
})));
|
|
1726
|
-
const
|
|
2186
|
+
const getTeamUsageContractV1 = base.route({
|
|
2187
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2188
|
+
method: "GET",
|
|
2189
|
+
summary: "Get team usage",
|
|
2190
|
+
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.",
|
|
2191
|
+
tags: ["teams"],
|
|
2192
|
+
successDescription: "The current billing window usage"
|
|
2193
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2194
|
+
teamId: z.string(),
|
|
2195
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2196
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2197
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2198
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2199
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2200
|
+
}));
|
|
2201
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1727
2202
|
path: "/v1/tunnels/ticket",
|
|
1728
2203
|
method: "GET",
|
|
1729
2204
|
summary: "Get a tunnel ticket",
|
|
@@ -1735,16 +2210,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1735
2210
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1736
2211
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1737
2212
|
}));
|
|
1738
|
-
const publishServerContractV1 =
|
|
2213
|
+
const publishServerContractV1 = base.route({
|
|
1739
2214
|
path: "/v1/distribution/publish",
|
|
1740
2215
|
method: "POST",
|
|
1741
2216
|
summary: "Publish a server to the MCP registry",
|
|
1742
2217
|
tags: ["distribution"],
|
|
1743
2218
|
successDescription: "The server has been published successfully"
|
|
1744
|
-
}).errors({
|
|
1745
|
-
NOT_FOUND: {},
|
|
1746
|
-
BAD_REQUEST: {}
|
|
1747
|
-
}).input(z.object({
|
|
2219
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1748
2220
|
projectId: z.string(),
|
|
1749
2221
|
domain: z.string(),
|
|
1750
2222
|
title: z.string().min(1).max(100),
|
|
@@ -1753,17 +2225,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1753
2225
|
iconSrc: z.url().max(255).optional(),
|
|
1754
2226
|
dryRun: z.boolean().optional()
|
|
1755
2227
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1756
|
-
const getServerInfoContractV1 =
|
|
2228
|
+
const getServerInfoContractV1 = base.route({
|
|
1757
2229
|
path: "/v1/distribution/get",
|
|
1758
2230
|
method: "GET",
|
|
1759
2231
|
summary: "Get server info",
|
|
1760
2232
|
description: "Get info about a server",
|
|
1761
2233
|
tags: ["distribution"],
|
|
1762
2234
|
successDescription: "The server info"
|
|
1763
|
-
}).errors({
|
|
1764
|
-
NOT_FOUND: {},
|
|
1765
|
-
BAD_REQUEST: {}
|
|
1766
|
-
}).input(z.object({
|
|
2235
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1767
2236
|
projectId: z.string(),
|
|
1768
2237
|
domain: z.string()
|
|
1769
2238
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1782,7 +2251,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1782
2251
|
isPlaygroundEnabled: z.boolean(),
|
|
1783
2252
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1784
2253
|
});
|
|
1785
|
-
const getPlaygroundContractV1 =
|
|
2254
|
+
const getPlaygroundContractV1 = base.route({
|
|
1786
2255
|
path: "/v1/environments/{environmentId}/playground",
|
|
1787
2256
|
method: "GET",
|
|
1788
2257
|
summary: "Get playground configuration",
|
|
@@ -1790,17 +2259,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1790
2259
|
tags: ["environments"],
|
|
1791
2260
|
successDescription: "The playground configuration"
|
|
1792
2261
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1793
|
-
const upsertPlaygroundContractV1 =
|
|
2262
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1794
2263
|
path: "/v1/environments/{environmentId}/playground",
|
|
1795
2264
|
method: "PUT",
|
|
1796
2265
|
summary: "Update playground configuration",
|
|
1797
2266
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1798
2267
|
tags: ["environments"],
|
|
1799
2268
|
successDescription: "The updated playground configuration"
|
|
1800
|
-
}).errors({
|
|
1801
|
-
NOT_FOUND: {},
|
|
1802
|
-
BAD_REQUEST: {}
|
|
1803
|
-
}).input(z.object({
|
|
2269
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1804
2270
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1805
2271
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1806
2272
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1808,7 +2274,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1808
2274
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1809
2275
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1810
2276
|
})).output(playgroundOutputSchema);
|
|
1811
|
-
const createBeaconContractV1 =
|
|
2277
|
+
const createBeaconContractV1 = base.route({
|
|
1812
2278
|
path: "/v1/beacon/audits",
|
|
1813
2279
|
method: "POST",
|
|
1814
2280
|
summary: "Create a beacon audit",
|
|
@@ -1817,7 +2283,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1817
2283
|
successDescription: "The audit has been created"
|
|
1818
2284
|
}).errors({
|
|
1819
2285
|
NOT_FOUND: {},
|
|
1820
|
-
BAD_REQUEST: {},
|
|
1821
2286
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1822
2287
|
}).input(z.object({
|
|
1823
2288
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1825,7 +2290,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1825
2290
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1826
2291
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1827
2292
|
})).output(z.object({ id: z.string() }));
|
|
1828
|
-
const getBeaconContractV1 =
|
|
2293
|
+
const getBeaconContractV1 = base.route({
|
|
1829
2294
|
path: "/v1/beacon/audits/{auditId}",
|
|
1830
2295
|
method: "GET",
|
|
1831
2296
|
summary: "Get a beacon audit",
|
|
@@ -1841,8 +2306,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1841
2306
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1842
2307
|
}));
|
|
1843
2308
|
const contract = {
|
|
1844
|
-
teams: {
|
|
2309
|
+
teams: {
|
|
2310
|
+
list: { v1: listTeamsContractV1 },
|
|
2311
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2312
|
+
},
|
|
1845
2313
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2314
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2315
|
+
intentCategories: {
|
|
2316
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2317
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2318
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2319
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2320
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2321
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2322
|
+
},
|
|
2323
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1846
2324
|
deployments: {
|
|
1847
2325
|
list: { v1: listDeploymentsContractV1 },
|
|
1848
2326
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1852,6 +2330,7 @@ const contract = {
|
|
|
1852
2330
|
environments: {
|
|
1853
2331
|
create: { v1: createEnvironmentContractV1 },
|
|
1854
2332
|
get: { v1: getEnvironmentContractV1 },
|
|
2333
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1855
2334
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1856
2335
|
getLogs: { v1: getLogsContractV1 },
|
|
1857
2336
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1883,5 +2362,10 @@ const contract = {
|
|
|
1883
2362
|
get: { v1: getBeaconContractV1 }
|
|
1884
2363
|
}
|
|
1885
2364
|
};
|
|
2365
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2366
|
+
const contractForDocs = {
|
|
2367
|
+
...contract,
|
|
2368
|
+
deployments: deploymentsForDocs
|
|
2369
|
+
};
|
|
1886
2370
|
//#endregion
|
|
1887
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2371
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|