@alpic-ai/api 0.0.0-dev.ge034e85 → 0.0.0-dev.ge038a40
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 +6714 -97
- package/dist/index.mjs +960 -189
- package/package.json +9 -9
package/dist/index.mjs
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
import * as z$1 from "zod/v4";
|
|
3
3
|
import { oc } from "@orpc/contract";
|
|
4
4
|
import ms from "ms";
|
|
5
|
-
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.32.1_supports-color@8.1.1_zod@4.5.4/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -119,7 +119,12 @@ z$1.object({
|
|
|
119
119
|
token_type: z$1.string(),
|
|
120
120
|
expires_in: z$1.coerce.number().optional(),
|
|
121
121
|
scope: z$1.string().optional(),
|
|
122
|
-
refresh_token: z$1.string().optional()
|
|
122
|
+
refresh_token: z$1.string().optional(),
|
|
123
|
+
/**
|
|
124
|
+
* Not part of the wire format: the authorization server this value was obtained from, added by
|
|
125
|
+
* the client's `auth()` before it is stored and compared when it is read back.
|
|
126
|
+
*/
|
|
127
|
+
issuer: z$1.string().optional().catch(void 0)
|
|
123
128
|
}).strip();
|
|
124
129
|
z$1.object({
|
|
125
130
|
error: z$1.string(),
|
|
@@ -158,7 +163,12 @@ const OAuthClientInformationSchema = z$1.object({
|
|
|
158
163
|
client_id: z$1.string(),
|
|
159
164
|
client_secret: z$1.string().optional(),
|
|
160
165
|
client_id_issued_at: z$1.number().optional(),
|
|
161
|
-
client_secret_expires_at: z$1.number().optional()
|
|
166
|
+
client_secret_expires_at: z$1.number().optional(),
|
|
167
|
+
/**
|
|
168
|
+
* Not part of the wire format: the authorization server this value was obtained from, added by
|
|
169
|
+
* the client's `auth()` before it is stored and compared when it is read back.
|
|
170
|
+
*/
|
|
171
|
+
issuer: z$1.string().optional().catch(void 0)
|
|
162
172
|
}).strip();
|
|
163
173
|
OAuthClientMetadataSchema.merge(OAuthClientInformationSchema);
|
|
164
174
|
z$1.object({
|
|
@@ -179,6 +189,7 @@ const PLATFORM_LABELS = {
|
|
|
179
189
|
};
|
|
180
190
|
const WAF_PLATFORMS = [
|
|
181
191
|
"akamai",
|
|
192
|
+
"cato",
|
|
182
193
|
"cloudflare",
|
|
183
194
|
"fastly"
|
|
184
195
|
];
|
|
@@ -256,6 +267,25 @@ z.object({
|
|
|
256
267
|
clientSecret: z.string(),
|
|
257
268
|
clientScopes: z.array(z.string())
|
|
258
269
|
});
|
|
270
|
+
const creditEntryReasonSchema = z.enum([
|
|
271
|
+
"free_seed",
|
|
272
|
+
"paid_conversion_floor",
|
|
273
|
+
"top_up",
|
|
274
|
+
"usage",
|
|
275
|
+
"admin_adjustment"
|
|
276
|
+
]);
|
|
277
|
+
z.enum(["playground"]);
|
|
278
|
+
z.number().int().min(500);
|
|
279
|
+
const creditActivityEntrySchema = z.object({
|
|
280
|
+
reason: creditEntryReasonSchema,
|
|
281
|
+
day: z.number(),
|
|
282
|
+
amountInNanoUSD: z.number(),
|
|
283
|
+
messageCount: z.number().nullable()
|
|
284
|
+
});
|
|
285
|
+
z.object({
|
|
286
|
+
balanceInNanoUSD: z.number(),
|
|
287
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
288
|
+
});
|
|
259
289
|
const deploymentStatusSchema$1 = z.enum([
|
|
260
290
|
"ongoing",
|
|
261
291
|
"deployed",
|
|
@@ -283,33 +313,18 @@ const deploymentSummarySchema = z.object({
|
|
|
283
313
|
createdAt: z.coerce.date(),
|
|
284
314
|
updatedAt: z.coerce.date()
|
|
285
315
|
});
|
|
286
|
-
/**
|
|
287
|
-
* Public environment
|
|
288
|
-
*
|
|
289
|
-
* Answers anonymously and exposes no OAuth metadata.
|
|
290
|
-
*/
|
|
316
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
291
317
|
const publicEnvironmentSchema = z.object({
|
|
292
318
|
allowsAnonymous: z.literal(true),
|
|
293
319
|
oAuthMetadata: z.strictObject({})
|
|
294
320
|
});
|
|
295
|
-
/**
|
|
296
|
-
* Protected environment with an external resource metadata URL
|
|
297
|
-
*
|
|
298
|
-
* An external resource metadata URL is returned in the WWW-Authenticate header during the first 401 response.
|
|
299
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
300
|
-
*/
|
|
321
|
+
/** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
|
|
301
322
|
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
302
323
|
allowsAnonymous: z.boolean(),
|
|
303
324
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
304
325
|
scope: z.string().optional()
|
|
305
326
|
});
|
|
306
|
-
/**
|
|
307
|
-
* Protected environment with an external authorization server URL
|
|
308
|
-
*
|
|
309
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
310
|
-
* An external authorization server URL is returned when requesting the endpoint.
|
|
311
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
312
|
-
*/
|
|
327
|
+
/** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
|
|
313
328
|
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
314
329
|
allowsAnonymous: z.boolean(),
|
|
315
330
|
oAuthMetadata: z.object({
|
|
@@ -318,12 +333,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
318
333
|
}),
|
|
319
334
|
scope: z.string().optional()
|
|
320
335
|
});
|
|
321
|
-
/**
|
|
322
|
-
* Standalone protected environment
|
|
323
|
-
*
|
|
324
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
325
|
-
* The server itself exposes the /.well-known/oauth-authorization-server endpoint.
|
|
326
|
-
*/
|
|
336
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
327
337
|
const standaloneEnvironmentSchema = z.object({
|
|
328
338
|
allowsAnonymous: z.boolean(),
|
|
329
339
|
oAuthMetadata: z.object({
|
|
@@ -332,17 +342,12 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
332
342
|
}),
|
|
333
343
|
scope: z.string().optional()
|
|
334
344
|
});
|
|
335
|
-
/**
|
|
336
|
-
* Protected environment without OAuth discovery
|
|
337
|
-
*
|
|
338
|
-
* The server enforces authentication but exposes no OAuth discovery metadata.
|
|
339
|
-
* Neither /.well-known/oauth-protected-resource nor /.well-known/oauth-authorization-server
|
|
340
|
-
* are advertised. Clients must obtain credentials out-of-band.
|
|
341
|
-
*/
|
|
345
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
342
346
|
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
343
347
|
allowsAnonymous: z.literal(false),
|
|
344
348
|
oAuthMetadata: z.strictObject({}),
|
|
345
|
-
scope: z.string().optional()
|
|
349
|
+
scope: z.string().optional(),
|
|
350
|
+
wwwAuthenticate: z.string().optional()
|
|
346
351
|
});
|
|
347
352
|
const legacyPublicEnvironmentSchema = z.object({
|
|
348
353
|
isPublic: z.literal(true),
|
|
@@ -387,10 +392,13 @@ z.union([
|
|
|
387
392
|
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
388
393
|
]);
|
|
389
394
|
const playgroundModelSchema = z.enum([
|
|
395
|
+
"global.anthropic.claude-haiku-5-5",
|
|
390
396
|
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
391
|
-
"global.anthropic.claude-sonnet-
|
|
397
|
+
"global.anthropic.claude-sonnet-5-5",
|
|
392
398
|
"openai.gpt-5.4",
|
|
393
|
-
"openai.gpt-5.5"
|
|
399
|
+
"openai.gpt-5.5",
|
|
400
|
+
"openai.gpt-6-luna",
|
|
401
|
+
"openai.gpt-6.1-sol"
|
|
394
402
|
]);
|
|
395
403
|
const environmentDomainSchema = z.object({
|
|
396
404
|
name: z.string(),
|
|
@@ -425,14 +433,17 @@ z.object({
|
|
|
425
433
|
collectRequestPayload: z.boolean(),
|
|
426
434
|
collectResponsePayload: z.boolean(),
|
|
427
435
|
collectErrorMessage: z.boolean(),
|
|
428
|
-
collectUserData: z.boolean()
|
|
436
|
+
collectUserData: z.boolean(),
|
|
437
|
+
identityTraitKey: z.string().min(1).max(200).nullable(),
|
|
438
|
+
leadEventName: z.string().min(1).max(200).nullable()
|
|
429
439
|
});
|
|
430
|
-
z.object({
|
|
440
|
+
const feedbackSchema = z.object({
|
|
431
441
|
id: z.string(),
|
|
432
442
|
createdAt: z.coerce.date(),
|
|
433
443
|
environmentId: z.string(),
|
|
434
444
|
content: z.string(),
|
|
435
|
-
source: z.enum(["model", "user"])
|
|
445
|
+
source: z.enum(["model", "user"]),
|
|
446
|
+
clientName: z.string().nullable()
|
|
436
447
|
});
|
|
437
448
|
z.object({
|
|
438
449
|
content: z.string(),
|
|
@@ -448,7 +459,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
448
459
|
"pink",
|
|
449
460
|
"gray"
|
|
450
461
|
]);
|
|
451
|
-
intentCategoryColorSchema.options;
|
|
462
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
452
463
|
const intentCategorySchema = z.object({
|
|
453
464
|
id: z.string(),
|
|
454
465
|
createdAt: z.coerce.date(),
|
|
@@ -456,7 +467,7 @@ const intentCategorySchema = z.object({
|
|
|
456
467
|
name: z.string(),
|
|
457
468
|
color: intentCategoryColorSchema
|
|
458
469
|
});
|
|
459
|
-
z.object({
|
|
470
|
+
const intentCategorySummarySchema = z.object({
|
|
460
471
|
id: z.string(),
|
|
461
472
|
name: z.string(),
|
|
462
473
|
color: intentCategoryColorSchema,
|
|
@@ -468,6 +479,7 @@ z.object({
|
|
|
468
479
|
environmentId: z.string(),
|
|
469
480
|
toolName: z.string(),
|
|
470
481
|
message: z.string(),
|
|
482
|
+
clientName: z.string().nullable(),
|
|
471
483
|
categories: z.array(intentCategorySchema)
|
|
472
484
|
});
|
|
473
485
|
const signalCategorySchema = z.object({
|
|
@@ -526,15 +538,274 @@ z.object({
|
|
|
526
538
|
createdAt: z.coerce.date(),
|
|
527
539
|
updatedAt: z.coerce.date()
|
|
528
540
|
});
|
|
541
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
542
|
+
type: z.literal("mcp_request"),
|
|
543
|
+
method: z.string()
|
|
544
|
+
});
|
|
545
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
546
|
+
type: z.literal("mcp_error"),
|
|
547
|
+
method: z.string(),
|
|
548
|
+
error: z.string()
|
|
549
|
+
});
|
|
550
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
529
551
|
z.enum([
|
|
530
552
|
"INFO",
|
|
531
553
|
"WARNING",
|
|
532
554
|
"DEBUG",
|
|
533
555
|
"ERROR"
|
|
534
556
|
]);
|
|
557
|
+
const LOG_SEARCH_MAX_ESCAPED_LENGTH = 960;
|
|
558
|
+
function escapeLogSearchTerm(search) {
|
|
559
|
+
return [...search].flatMap((character) => [...new TextEncoder().encode(character)]).map((byte) => {
|
|
560
|
+
const character = String.fromCharCode(byte);
|
|
561
|
+
return /^[a-zA-Z0-9]$/.test(character) ? character : `\\x${byte.toString(16).toUpperCase().padStart(2, "0")}`;
|
|
562
|
+
}).join("");
|
|
563
|
+
}
|
|
564
|
+
const logSearchSchema = z.string().max(240, `Search must be 240 characters or fewer`).refine((search) => escapeLogSearchTerm(search).length <= LOG_SEARCH_MAX_ESCAPED_LENGTH, "Search is too complex; shorten it or use fewer special characters");
|
|
565
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
566
|
+
const MCP_CLIENT_GROUPS = [
|
|
567
|
+
{
|
|
568
|
+
id: "claude_code",
|
|
569
|
+
label: "Claude Code",
|
|
570
|
+
vendor: "anthropic",
|
|
571
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
572
|
+
},
|
|
573
|
+
{
|
|
574
|
+
id: "claude",
|
|
575
|
+
label: "Claude",
|
|
576
|
+
vendor: "anthropic",
|
|
577
|
+
rawNames: [
|
|
578
|
+
"Anthropic/ClaudeAI",
|
|
579
|
+
"claude-ai",
|
|
580
|
+
"claude",
|
|
581
|
+
"Claude",
|
|
582
|
+
"claude-desktop",
|
|
583
|
+
"claude-desktop-3p"
|
|
584
|
+
]
|
|
585
|
+
},
|
|
586
|
+
{
|
|
587
|
+
id: "claude_mobile",
|
|
588
|
+
label: "Claude mobile",
|
|
589
|
+
vendor: "anthropic",
|
|
590
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
591
|
+
},
|
|
592
|
+
{
|
|
593
|
+
id: "claude_cowork",
|
|
594
|
+
label: "Claude Cowork",
|
|
595
|
+
vendor: "anthropic",
|
|
596
|
+
rawNames: ["Anthropic/Cowork"]
|
|
597
|
+
},
|
|
598
|
+
{
|
|
599
|
+
id: "claude_sheet_add_in",
|
|
600
|
+
label: "Claude (Sheet Add-In)",
|
|
601
|
+
vendor: "anthropic",
|
|
602
|
+
rawNames: ["sheet-add-in"]
|
|
603
|
+
},
|
|
604
|
+
{
|
|
605
|
+
id: "claude_toolbox",
|
|
606
|
+
label: "Claude Toolbox",
|
|
607
|
+
vendor: "anthropic",
|
|
608
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
609
|
+
},
|
|
610
|
+
{
|
|
611
|
+
id: "anthropic_api",
|
|
612
|
+
label: "Anthropic API",
|
|
613
|
+
vendor: "anthropic",
|
|
614
|
+
rawNames: ["Anthropic/API"]
|
|
615
|
+
},
|
|
616
|
+
{
|
|
617
|
+
id: "anthropic_connector_refresh",
|
|
618
|
+
label: "Anthropic (connector refresh)",
|
|
619
|
+
vendor: "anthropic",
|
|
620
|
+
rawNames: ["Anthropic"]
|
|
621
|
+
},
|
|
622
|
+
{
|
|
623
|
+
id: "codex",
|
|
624
|
+
label: "Codex",
|
|
625
|
+
vendor: "openai",
|
|
626
|
+
rawNames: [
|
|
627
|
+
"codex-mcp-client",
|
|
628
|
+
"codex",
|
|
629
|
+
"Codex",
|
|
630
|
+
"codex-cli",
|
|
631
|
+
"openai-mcp (Codex)"
|
|
632
|
+
]
|
|
633
|
+
},
|
|
634
|
+
{
|
|
635
|
+
id: "chatgpt",
|
|
636
|
+
label: "ChatGPT",
|
|
637
|
+
vendor: "openai",
|
|
638
|
+
rawNames: ["openai-mcp", "openai-mcp (ChatGPT)"]
|
|
639
|
+
},
|
|
640
|
+
{
|
|
641
|
+
id: "openai_responses_api",
|
|
642
|
+
label: "OpenAI Responses API",
|
|
643
|
+
vendor: "openai",
|
|
644
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
645
|
+
},
|
|
646
|
+
{
|
|
647
|
+
id: "openai_agent_builder",
|
|
648
|
+
label: "OpenAI Agent Builder",
|
|
649
|
+
vendor: "openai",
|
|
650
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
651
|
+
},
|
|
652
|
+
{
|
|
653
|
+
id: "cursor",
|
|
654
|
+
label: "Cursor",
|
|
655
|
+
vendor: "cursor",
|
|
656
|
+
rawNames: [
|
|
657
|
+
"cursor-vscode",
|
|
658
|
+
"Cursor",
|
|
659
|
+
"cursor"
|
|
660
|
+
]
|
|
661
|
+
},
|
|
662
|
+
{
|
|
663
|
+
id: "cline",
|
|
664
|
+
label: "Cline",
|
|
665
|
+
vendor: "cline",
|
|
666
|
+
rawNames: [
|
|
667
|
+
"Cline",
|
|
668
|
+
"cline",
|
|
669
|
+
"@cline/core"
|
|
670
|
+
]
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
id: "github_copilot",
|
|
674
|
+
label: "GitHub Copilot",
|
|
675
|
+
vendor: "githubCopilot",
|
|
676
|
+
rawNames: [
|
|
677
|
+
"Copilot",
|
|
678
|
+
"github-copilot-developer",
|
|
679
|
+
"Copilot MCP Gateway",
|
|
680
|
+
"Xcode/copilot-xcode"
|
|
681
|
+
]
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
id: "gemini_cli",
|
|
685
|
+
label: "Gemini CLI",
|
|
686
|
+
vendor: "google",
|
|
687
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
688
|
+
},
|
|
689
|
+
{
|
|
690
|
+
id: "antigravity",
|
|
691
|
+
label: "Antigravity",
|
|
692
|
+
vendor: "google",
|
|
693
|
+
rawNames: ["antigravity-client"]
|
|
694
|
+
},
|
|
695
|
+
{
|
|
696
|
+
id: "gemini",
|
|
697
|
+
label: "Gemini",
|
|
698
|
+
vendor: "google",
|
|
699
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "windsurf",
|
|
703
|
+
label: "Windsurf",
|
|
704
|
+
vendor: "windsurf",
|
|
705
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
id: "mistral",
|
|
709
|
+
label: "Mistral / Le Chat",
|
|
710
|
+
vendor: "mistral",
|
|
711
|
+
rawNames: ["Mistral"],
|
|
712
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
713
|
+
},
|
|
714
|
+
{
|
|
715
|
+
id: "n8n",
|
|
716
|
+
label: "n8n",
|
|
717
|
+
vendor: "n8n",
|
|
718
|
+
rawNames: [
|
|
719
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
720
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
721
|
+
"n8n"
|
|
722
|
+
]
|
|
723
|
+
},
|
|
724
|
+
{
|
|
725
|
+
id: "alpic_playground",
|
|
726
|
+
label: "Alpic Playground",
|
|
727
|
+
vendor: "alpic",
|
|
728
|
+
rawNames: ["alpic-playground", "playground"]
|
|
729
|
+
},
|
|
730
|
+
{
|
|
731
|
+
id: "opencode",
|
|
732
|
+
label: "opencode",
|
|
733
|
+
vendor: "opencode",
|
|
734
|
+
rawNames: ["opencode"]
|
|
735
|
+
},
|
|
736
|
+
{
|
|
737
|
+
id: "zed",
|
|
738
|
+
label: "Zed",
|
|
739
|
+
vendor: "zed",
|
|
740
|
+
rawNames: ["Zed", "zed"]
|
|
741
|
+
},
|
|
742
|
+
{
|
|
743
|
+
id: "zapier",
|
|
744
|
+
label: "Zapier",
|
|
745
|
+
vendor: "zapier",
|
|
746
|
+
rawNames: ["Zapier", "zapier"]
|
|
747
|
+
},
|
|
748
|
+
{
|
|
749
|
+
id: "make",
|
|
750
|
+
label: "Make",
|
|
751
|
+
vendor: "make",
|
|
752
|
+
rawNames: ["Make", "make"]
|
|
753
|
+
},
|
|
754
|
+
{
|
|
755
|
+
id: "librechat",
|
|
756
|
+
label: "LibreChat",
|
|
757
|
+
vendor: "mcp",
|
|
758
|
+
rawNames: ["LibreChat", "librechat"]
|
|
759
|
+
},
|
|
760
|
+
{
|
|
761
|
+
id: "jan",
|
|
762
|
+
label: "Jan",
|
|
763
|
+
vendor: "mcp",
|
|
764
|
+
rawNames: ["Jan", "jan"]
|
|
765
|
+
},
|
|
766
|
+
{
|
|
767
|
+
id: "goose",
|
|
768
|
+
label: "goose",
|
|
769
|
+
vendor: "mcp",
|
|
770
|
+
rawNames: ["goose", "Goose"]
|
|
771
|
+
},
|
|
772
|
+
{
|
|
773
|
+
id: "mcphost",
|
|
774
|
+
label: "mcphost",
|
|
775
|
+
vendor: "mcp",
|
|
776
|
+
rawNames: ["mcphost"]
|
|
777
|
+
},
|
|
778
|
+
{
|
|
779
|
+
id: "mcporter",
|
|
780
|
+
label: "mcporter",
|
|
781
|
+
vendor: "mcp",
|
|
782
|
+
rawNames: ["mcporter"]
|
|
783
|
+
},
|
|
784
|
+
{
|
|
785
|
+
id: "rmcp",
|
|
786
|
+
label: "rmcp",
|
|
787
|
+
vendor: "mcp",
|
|
788
|
+
rawNames: ["rmcp"]
|
|
789
|
+
},
|
|
790
|
+
{
|
|
791
|
+
id: "unnamed_client",
|
|
792
|
+
label: "Unnamed client",
|
|
793
|
+
vendor: "mcp",
|
|
794
|
+
rawNames: [
|
|
795
|
+
"mcp",
|
|
796
|
+
"unknown",
|
|
797
|
+
""
|
|
798
|
+
]
|
|
799
|
+
}
|
|
800
|
+
];
|
|
801
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
802
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
803
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
804
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
535
805
|
const runtimeSchema = z.enum([
|
|
536
806
|
"python3.13",
|
|
537
807
|
"python3.14",
|
|
808
|
+
"python3.15",
|
|
538
809
|
"node22",
|
|
539
810
|
"node24"
|
|
540
811
|
]);
|
|
@@ -609,15 +880,55 @@ z.object({
|
|
|
609
880
|
serverFields: serverFieldsSchema$1,
|
|
610
881
|
source: z.enum(["registry", "defaults"])
|
|
611
882
|
});
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
883
|
+
function detectPythonRuntimeFromRequirement(requiresPython) {
|
|
884
|
+
const constraints = requiresPython.split(",").map((specifier) => {
|
|
885
|
+
const match = specifier.trim().match(/^(>=|<=|~=|===|==|!=|>|<)?\s*(\d+)(?:\.(\d+))?(?:\.(\d+))?(\.\*)?$/);
|
|
886
|
+
if (!match || match[5] && (match[4] || ![
|
|
887
|
+
"==",
|
|
888
|
+
"!=",
|
|
889
|
+
void 0
|
|
890
|
+
].includes(match[1])) || match[1] === "~=" && !match[3]) return null;
|
|
891
|
+
return {
|
|
892
|
+
operator: match[1] ?? "==",
|
|
893
|
+
major: Number(match[2]),
|
|
894
|
+
minor: Number(match[3] ?? 0),
|
|
895
|
+
patch: Number(match[4] ?? 0),
|
|
896
|
+
hasMinor: match[3] !== void 0,
|
|
897
|
+
hasPatch: match[4] !== void 0,
|
|
898
|
+
wildcard: match[5] !== void 0
|
|
899
|
+
};
|
|
900
|
+
});
|
|
901
|
+
if (constraints.some((constraint) => constraint === null)) return;
|
|
902
|
+
const parsed = constraints.filter((constraint) => constraint !== null);
|
|
903
|
+
const lowerBounds = parsed.filter(({ operator, major }) => major === 3 && ![
|
|
904
|
+
"<",
|
|
905
|
+
"<=",
|
|
906
|
+
"!="
|
|
907
|
+
].includes(operator)).map(({ minor }) => minor);
|
|
908
|
+
const preferredMinor = Math.max(...lowerBounds.length ? lowerBounds : [14]);
|
|
909
|
+
const supportedRuntimes = runtimeSchema.options.filter((runtime) => runtime.startsWith("python")).map((runtime) => ({
|
|
910
|
+
runtime,
|
|
911
|
+
minor: Number(runtime.split(".")[1])
|
|
912
|
+
}));
|
|
913
|
+
const candidates = [...supportedRuntimes.filter(({ minor }) => minor === preferredMinor), ...supportedRuntimes.filter(({ minor }) => minor !== preferredMinor)];
|
|
914
|
+
const patches = [0, ...parsed.flatMap(({ patch }) => [patch, patch + 1])];
|
|
915
|
+
return candidates.find(({ minor }) => patches.some((patch) => parsed.every((constraint) => {
|
|
916
|
+
const comparison = 3 - constraint.major || minor - constraint.minor || patch - constraint.patch;
|
|
917
|
+
const matches = constraint.wildcard ? constraint.major === 3 && (!constraint.hasMinor || minor === constraint.minor) : comparison === 0;
|
|
918
|
+
switch (constraint.operator) {
|
|
919
|
+
case "==":
|
|
920
|
+
case "===": return matches;
|
|
921
|
+
case "!=": return !matches;
|
|
922
|
+
case ">=": return comparison >= 0;
|
|
923
|
+
case ">": return comparison > 0;
|
|
924
|
+
case "<=": return comparison <= 0;
|
|
925
|
+
case "<": return comparison < 0;
|
|
926
|
+
case "~=": return comparison >= 0 && constraint.major === 3 && (!constraint.hasPatch || minor === constraint.minor);
|
|
927
|
+
default: return false;
|
|
928
|
+
}
|
|
929
|
+
})))?.runtime ?? null;
|
|
930
|
+
}
|
|
931
|
+
/** 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. */
|
|
621
932
|
const clampStringField = (field) => {
|
|
622
933
|
const max = field.maxLength;
|
|
623
934
|
if (max === null) return field;
|
|
@@ -625,6 +936,10 @@ const clampStringField = (field) => {
|
|
|
625
936
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
626
937
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
627
938
|
};
|
|
939
|
+
const unboundedArrayField = (field) => {
|
|
940
|
+
const unbounded = z.array(field.element);
|
|
941
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
942
|
+
};
|
|
628
943
|
const toolDefinitionSchema = z.object({
|
|
629
944
|
name: z.string(),
|
|
630
945
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -637,11 +952,22 @@ const toolDefinitionSchema = z.object({
|
|
|
637
952
|
}).optional()
|
|
638
953
|
});
|
|
639
954
|
const positiveTestCaseSchema = z.object({
|
|
640
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
641
|
-
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."),
|
|
955
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
956
|
+
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."),
|
|
642
957
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
643
958
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
644
|
-
}).
|
|
959
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
960
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
961
|
+
scenario: z.string().optional(),
|
|
962
|
+
userPrompt: z.string().optional()
|
|
963
|
+
});
|
|
964
|
+
const blankPositiveTestCase = () => ({
|
|
965
|
+
scenario: "",
|
|
966
|
+
userPrompt: "",
|
|
967
|
+
toolTriggered: "",
|
|
968
|
+
expectedOutput: ""
|
|
969
|
+
});
|
|
970
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
645
971
|
const screenshotEntrySchema = z.object({
|
|
646
972
|
prompt: z.string(),
|
|
647
973
|
url: z.url()
|
|
@@ -954,20 +1280,25 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
954
1280
|
"zh-TW"
|
|
955
1281
|
]);
|
|
956
1282
|
const negativeTestCaseSchema = z.object({
|
|
957
|
-
scenario: z.string(),
|
|
958
|
-
userPrompt: z.string()
|
|
959
|
-
}).
|
|
1283
|
+
scenario: z.string().min(1),
|
|
1284
|
+
userPrompt: z.string().min(1)
|
|
1285
|
+
}).describe("Each case: Scenario + User prompt (the plugin should NOT trigger).");
|
|
1286
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1287
|
+
scenario: z.string().optional(),
|
|
1288
|
+
userPrompt: z.string().optional()
|
|
1289
|
+
});
|
|
1290
|
+
const blankNegativeTestCase = () => ({
|
|
1291
|
+
scenario: "",
|
|
1292
|
+
userPrompt: ""
|
|
1293
|
+
});
|
|
1294
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
960
1295
|
const chatgptToolJustificationSchema = z.object({
|
|
961
1296
|
toolName: z.string(),
|
|
962
1297
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
963
1298
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
964
1299
|
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.\"")
|
|
965
1300
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
966
|
-
/**
|
|
967
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
968
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
969
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
970
|
-
*/
|
|
1301
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
971
1302
|
const chatgptTaglineSchema = z.string().max(30);
|
|
972
1303
|
const chatgptDescriptionSchema = z.string();
|
|
973
1304
|
const chatgptTranslationSchema = z.object({
|
|
@@ -976,34 +1307,32 @@ const chatgptTranslationSchema = z.object({
|
|
|
976
1307
|
description: chatgptDescriptionSchema
|
|
977
1308
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
978
1309
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
979
|
-
/**
|
|
980
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
981
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
982
|
-
*/
|
|
1310
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
983
1311
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
984
1312
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
985
1313
|
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."),
|
|
986
|
-
appName: z.string().describe("The name users will see in ChatGPT and in the
|
|
1314
|
+
appName: z.string().describe("The name users will see in ChatGPT and in the Plugin Directory."),
|
|
987
1315
|
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
988
|
-
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the
|
|
1316
|
+
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the plugin does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the plugin does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
|
|
989
1317
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
990
|
-
developerName: z.string().describe("Developer name shown publicly on the
|
|
1318
|
+
developerName: z.string().describe("Developer name shown publicly on the plugin's directory page."),
|
|
991
1319
|
companyUrl: urlField.describe("Your company's main website URL."),
|
|
992
1320
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
993
1321
|
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
994
|
-
termsOfServiceUrl: urlField.describe("URL to the
|
|
995
|
-
demoRecordingUrl: urlField.describe("URL to a video demonstrating the
|
|
996
|
-
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My
|
|
1322
|
+
termsOfServiceUrl: urlField.describe("URL to the plugin's terms of service."),
|
|
1323
|
+
demoRecordingUrl: urlField.describe("URL to a video demonstrating the plugin, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
1324
|
+
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My plugin links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the plugin does not offer digital goods."),
|
|
997
1325
|
serverUrl: urlField.describe("URL of the MCP server."),
|
|
998
1326
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
999
1327
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1000
1328
|
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."),
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1329
|
+
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."),
|
|
1330
|
+
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."),
|
|
1331
|
+
negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 3 negative test cases: prompts where the plugin should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the plugin does not carry, the right brand or domain but an intent the plugin does not serve, or a boundary with a sibling plugin."),
|
|
1332
|
+
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-plugin screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget plugins must show the widget UI; non-widget plugins show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
1004
1333
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1005
1334
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
1006
|
-
releaseNotes: z.string().describe("Publicly displayed on the
|
|
1335
|
+
releaseNotes: z.string().describe("Publicly displayed on the plugin details page.")
|
|
1007
1336
|
});
|
|
1008
1337
|
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1009
1338
|
tagline: z.string().optional(),
|
|
@@ -1014,23 +1343,35 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
1014
1343
|
demoRecordingUrl: z.string().optional(),
|
|
1015
1344
|
serverUrl: z.string().optional(),
|
|
1016
1345
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1346
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1347
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1017
1348
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1018
1349
|
});
|
|
1019
|
-
|
|
1350
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1351
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1020
1352
|
appName: true,
|
|
1021
1353
|
developerName: true,
|
|
1022
1354
|
serverUrl: true,
|
|
1023
1355
|
tools: true,
|
|
1356
|
+
skills: true,
|
|
1024
1357
|
authentication: true
|
|
1025
1358
|
});
|
|
1026
|
-
|
|
1359
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1360
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1027
1361
|
tagline: true,
|
|
1028
1362
|
description: true,
|
|
1029
1363
|
category: true,
|
|
1030
1364
|
testCases: true,
|
|
1031
1365
|
negativeTestCases: true,
|
|
1032
1366
|
toolJustifications: true
|
|
1033
|
-
}).extend({
|
|
1367
|
+
}).extend({
|
|
1368
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1369
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1370
|
+
}).extend({
|
|
1371
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1372
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1373
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1374
|
+
});
|
|
1034
1375
|
const claudeCategorySchema = z.enum([
|
|
1035
1376
|
"Productivity",
|
|
1036
1377
|
"Communication",
|
|
@@ -1076,11 +1417,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1076
1417
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1077
1418
|
"Public documentation for this connector will be live by the publish date."
|
|
1078
1419
|
]);
|
|
1079
|
-
/**
|
|
1080
|
-
* Field order mirrors the claude.ai directory submission wizard
|
|
1081
|
-
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1082
|
-
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1083
|
-
*/
|
|
1420
|
+
/** 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. */
|
|
1084
1421
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1085
1422
|
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
|
|
1086
1423
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1157,7 +1494,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1157
1494
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1158
1495
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1159
1496
|
});
|
|
1160
|
-
|
|
1497
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1498
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1161
1499
|
serverUrl: true,
|
|
1162
1500
|
name: true,
|
|
1163
1501
|
slug: true,
|
|
@@ -1172,39 +1510,93 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1172
1510
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1173
1511
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1174
1512
|
});
|
|
1175
|
-
/**
|
|
1176
|
-
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1177
|
-
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1178
|
-
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1179
|
-
* colocated with the Claude contract.
|
|
1180
|
-
*/
|
|
1513
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1181
1514
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1182
1515
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1183
1516
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1184
1517
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1185
1518
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1186
1519
|
});
|
|
1187
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1520
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1188
1521
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1189
1522
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1190
1523
|
});
|
|
1524
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1525
|
+
const byField = {};
|
|
1526
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1527
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1528
|
+
return byField;
|
|
1529
|
+
}
|
|
1530
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1531
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1532
|
+
"pass",
|
|
1533
|
+
"fail",
|
|
1534
|
+
"unverified"
|
|
1535
|
+
]);
|
|
1536
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1537
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1538
|
+
claudeai: ["privacyPolicy"]
|
|
1539
|
+
};
|
|
1540
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1541
|
+
const policyDisclosureSchema = z.enum([
|
|
1542
|
+
"dataCategories",
|
|
1543
|
+
"purposesOfUse",
|
|
1544
|
+
"recipients",
|
|
1545
|
+
"retention"
|
|
1546
|
+
]);
|
|
1547
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1548
|
+
field: verifiableUrlFieldSchema,
|
|
1549
|
+
url: z.string(),
|
|
1550
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1551
|
+
reason: z.string(),
|
|
1552
|
+
concerns: z.array(z.string()).optional(),
|
|
1553
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1554
|
+
});
|
|
1555
|
+
const urlVerificationSchema = z.object({
|
|
1556
|
+
verifiedAt: z.coerce.date(),
|
|
1557
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1558
|
+
});
|
|
1559
|
+
const pageKindSchema = z.enum([
|
|
1560
|
+
"expectedDocument",
|
|
1561
|
+
"errorPage",
|
|
1562
|
+
"loginWall",
|
|
1563
|
+
"parkedDomain",
|
|
1564
|
+
"comingSoon",
|
|
1565
|
+
"marketingPage",
|
|
1566
|
+
"unrelatedDocument"
|
|
1567
|
+
]);
|
|
1568
|
+
z.object({
|
|
1569
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1570
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1571
|
+
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.")
|
|
1572
|
+
});
|
|
1191
1573
|
const submissionMetaFieldsSchema = z.object({
|
|
1192
1574
|
id: z.string(),
|
|
1193
1575
|
environmentId: z.string(),
|
|
1194
1576
|
auditId: z.string().nullable(),
|
|
1577
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1195
1578
|
createdAt: z.coerce.date(),
|
|
1196
1579
|
updatedAt: z.coerce.date()
|
|
1197
1580
|
});
|
|
1198
1581
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1199
1582
|
platform: z.literal("claudeai"),
|
|
1200
|
-
formData: claudeSubmissionDraftSchema
|
|
1583
|
+
formData: claudeSubmissionDraftSchema,
|
|
1584
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1201
1585
|
});
|
|
1202
1586
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1203
1587
|
platform: z.literal("chatgpt"),
|
|
1204
|
-
formData: chatgptSubmissionDraftSchema
|
|
1588
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1589
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1205
1590
|
});
|
|
1206
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1591
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1207
1592
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1593
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1594
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1595
|
+
z.literal([
|
|
1596
|
+
100,
|
|
1597
|
+
75,
|
|
1598
|
+
50
|
|
1599
|
+
]);
|
|
1208
1600
|
const subscriptionPlanSchema = z.enum([
|
|
1209
1601
|
"pro",
|
|
1210
1602
|
"business",
|
|
@@ -1216,17 +1608,78 @@ const customerCreditsSchema = z.object({
|
|
|
1216
1608
|
expiresAt: z.number().nullable(),
|
|
1217
1609
|
currency: z.string()
|
|
1218
1610
|
});
|
|
1219
|
-
const customerUsageSchema = z.object({
|
|
1220
|
-
amountInCents: z.number(),
|
|
1221
|
-
currency: z.string(),
|
|
1222
|
-
periodEnd: z.number()
|
|
1223
|
-
});
|
|
1224
1611
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1225
1612
|
z.object({
|
|
1226
1613
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1227
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1228
1614
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1229
1615
|
});
|
|
1616
|
+
const metricsQueueEventSchema = z.object({
|
|
1617
|
+
ts: z.number().int(),
|
|
1618
|
+
method: z.string(),
|
|
1619
|
+
tool: z.string().nullable(),
|
|
1620
|
+
client: z.string(),
|
|
1621
|
+
sessionId: z.string().nullable(),
|
|
1622
|
+
conversationId: z.string().nullable().optional(),
|
|
1623
|
+
durationMs: z.number().int(),
|
|
1624
|
+
outputTokens: z.number().int().nullable(),
|
|
1625
|
+
errorType: z.enum([
|
|
1626
|
+
"mcp_error",
|
|
1627
|
+
"tool_error",
|
|
1628
|
+
"timeout"
|
|
1629
|
+
]).nullable(),
|
|
1630
|
+
errorCode: z.number().int().nullable()
|
|
1631
|
+
});
|
|
1632
|
+
z.object({
|
|
1633
|
+
v: z.literal(1),
|
|
1634
|
+
envId: z.string(),
|
|
1635
|
+
events: z.array(metricsQueueEventSchema)
|
|
1636
|
+
});
|
|
1637
|
+
z.object({ v: z.number() });
|
|
1638
|
+
const TELEMETRY_SIGNALS = [
|
|
1639
|
+
"logs",
|
|
1640
|
+
"metrics",
|
|
1641
|
+
"traces"
|
|
1642
|
+
];
|
|
1643
|
+
const telemetrySignalSchema = z.enum(TELEMETRY_SIGNALS);
|
|
1644
|
+
const OTLP_PROTOCOLS = ["http/protobuf", "http/json"];
|
|
1645
|
+
const otlpProtocolSchema = z.enum(OTLP_PROTOCOLS);
|
|
1646
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1647
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1648
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1649
|
+
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");
|
|
1650
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1651
|
+
id: z.string(),
|
|
1652
|
+
name: otlpHeaderNameSchema,
|
|
1653
|
+
value: otlpHeaderValueSchema,
|
|
1654
|
+
isSecret: z.boolean()
|
|
1655
|
+
});
|
|
1656
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1657
|
+
"credentials",
|
|
1658
|
+
"wrong-path",
|
|
1659
|
+
"wrong-protocol",
|
|
1660
|
+
"invalid-payload",
|
|
1661
|
+
"partial-rejection",
|
|
1662
|
+
"blocked-target",
|
|
1663
|
+
"timeout",
|
|
1664
|
+
"unreachable",
|
|
1665
|
+
"receiver-error",
|
|
1666
|
+
"unexpected-status"
|
|
1667
|
+
]);
|
|
1668
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1669
|
+
z.object({
|
|
1670
|
+
id: z.string(),
|
|
1671
|
+
signal: telemetrySignalSchema,
|
|
1672
|
+
endpoint: otlpEndpointSchema,
|
|
1673
|
+
protocol: otlpProtocolSchema,
|
|
1674
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1675
|
+
status: telemetryDestinationStatusSchema,
|
|
1676
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable(),
|
|
1677
|
+
isScopedToIntentionalRequestsOnly: z.boolean()
|
|
1678
|
+
});
|
|
1679
|
+
const hasDuplicateHeaderNames = (headers) => {
|
|
1680
|
+
const names = headers.map(({ name }) => name.trim().toLowerCase());
|
|
1681
|
+
return new Set(names).size !== names.length;
|
|
1682
|
+
};
|
|
1230
1683
|
//#endregion
|
|
1231
1684
|
//#region src/auth-scope.ts
|
|
1232
1685
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1269,7 +1722,10 @@ const RESERVED_KEYS = [
|
|
|
1269
1722
|
"BUILD_ARG_START_COMMAND",
|
|
1270
1723
|
"ALPIC_HOST",
|
|
1271
1724
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1272
|
-
"ALPIC_INTENT_META_KEY"
|
|
1725
|
+
"ALPIC_INTENT_META_KEY",
|
|
1726
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1727
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1728
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1273
1729
|
];
|
|
1274
1730
|
const environmentVariableSchema = z.object({
|
|
1275
1731
|
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"),
|
|
@@ -1322,6 +1778,14 @@ const serverFieldsSchema = z.object({
|
|
|
1322
1778
|
});
|
|
1323
1779
|
//#endregion
|
|
1324
1780
|
//#region src/api.contract.ts
|
|
1781
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1782
|
+
try {
|
|
1783
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1784
|
+
return true;
|
|
1785
|
+
} catch {
|
|
1786
|
+
return false;
|
|
1787
|
+
}
|
|
1788
|
+
};
|
|
1325
1789
|
const deploymentStatusSchema = z.enum([
|
|
1326
1790
|
"ongoing",
|
|
1327
1791
|
"deployed",
|
|
@@ -1350,21 +1814,20 @@ const deploymentSchema = z.object({
|
|
|
1350
1814
|
isCurrent: z.boolean(),
|
|
1351
1815
|
deploymentPageUrl: z.url().nullable()
|
|
1352
1816
|
});
|
|
1353
|
-
const
|
|
1817
|
+
const isValidTimeInput = (value) => {
|
|
1354
1818
|
if (ms(value) !== void 0) return true;
|
|
1355
1819
|
return !Number.isNaN(new Date(value).getTime());
|
|
1356
1820
|
};
|
|
1357
|
-
const
|
|
1821
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1822
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1823
|
+
const createEnvironmentContractV1 = base.route({
|
|
1358
1824
|
path: "/v1/environments",
|
|
1359
1825
|
method: "POST",
|
|
1360
1826
|
summary: "Create an environment",
|
|
1361
1827
|
description: "Create an environment for a project",
|
|
1362
1828
|
tags: ["environments"],
|
|
1363
1829
|
successDescription: "The environment has been created successfully"
|
|
1364
|
-
}).errors({
|
|
1365
|
-
NOT_FOUND: {},
|
|
1366
|
-
BAD_REQUEST: {}
|
|
1367
|
-
}).input(z.object({
|
|
1830
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1368
1831
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1369
1832
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1370
1833
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1377,7 +1840,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1377
1840
|
createdAt: z.coerce.date(),
|
|
1378
1841
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1379
1842
|
}));
|
|
1380
|
-
const getEnvironmentContractV1 =
|
|
1843
|
+
const getEnvironmentContractV1 = base.route({
|
|
1381
1844
|
path: "/v1/environments/{environmentId}",
|
|
1382
1845
|
method: "GET",
|
|
1383
1846
|
summary: "Get an environment",
|
|
@@ -1393,6 +1856,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1393
1856
|
createdAt: z.coerce.date(),
|
|
1394
1857
|
projectId: z.string()
|
|
1395
1858
|
}));
|
|
1859
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1860
|
+
path: "/v1/environments/{environmentId}",
|
|
1861
|
+
method: "DELETE",
|
|
1862
|
+
summary: "Delete an environment",
|
|
1863
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1864
|
+
tags: ["environments"],
|
|
1865
|
+
successDescription: "The environment has been deleted successfully"
|
|
1866
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1396
1867
|
const domainSchema = z.object({
|
|
1397
1868
|
domain: z.string(),
|
|
1398
1869
|
status: z.enum([
|
|
@@ -1434,7 +1905,7 @@ const projectOutputSchema = z.object({
|
|
|
1434
1905
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1435
1906
|
environments: z.array(environmentSchema)
|
|
1436
1907
|
});
|
|
1437
|
-
const getProjectContractV1 =
|
|
1908
|
+
const getProjectContractV1 = base.route({
|
|
1438
1909
|
path: "/v1/projects/{projectId}",
|
|
1439
1910
|
method: "GET",
|
|
1440
1911
|
summary: "Get a project",
|
|
@@ -1442,18 +1913,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1442
1913
|
tags: ["projects"],
|
|
1443
1914
|
successDescription: "The project details"
|
|
1444
1915
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1445
|
-
const listProjectsContractV1 =
|
|
1916
|
+
const listProjectsContractV1 = base.route({
|
|
1446
1917
|
path: "/v1/projects",
|
|
1447
1918
|
method: "GET",
|
|
1448
1919
|
summary: "List projects",
|
|
1449
1920
|
description: "List all projects for a team",
|
|
1450
1921
|
tags: ["projects"],
|
|
1451
1922
|
successDescription: "The list of projects"
|
|
1452
|
-
}).errors({
|
|
1453
|
-
|
|
1454
|
-
BAD_REQUEST: {}
|
|
1455
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1456
|
-
const createProjectContractV1 = oc.route({
|
|
1923
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1924
|
+
const createProjectContractV1 = base.route({
|
|
1457
1925
|
path: "/v1/projects",
|
|
1458
1926
|
method: "POST",
|
|
1459
1927
|
summary: "Create a project",
|
|
@@ -1462,7 +1930,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1462
1930
|
successDescription: "The project has been created successfully"
|
|
1463
1931
|
}).errors({
|
|
1464
1932
|
NOT_FOUND: {},
|
|
1465
|
-
BAD_REQUEST: {},
|
|
1466
1933
|
FORBIDDEN: {}
|
|
1467
1934
|
}).input(z.object({
|
|
1468
1935
|
teamId: z.string().optional(),
|
|
@@ -1503,7 +1970,101 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1503
1970
|
isSecret: z.boolean(),
|
|
1504
1971
|
createdAt: z.coerce.date()
|
|
1505
1972
|
});
|
|
1506
|
-
const
|
|
1973
|
+
const telemetryDestinationHeaderOutputSchema = z.discriminatedUnion("isSecret", [z.object({
|
|
1974
|
+
id: z.string(),
|
|
1975
|
+
name: otlpHeaderNameSchema,
|
|
1976
|
+
value: z.null(),
|
|
1977
|
+
isSecret: z.literal(true)
|
|
1978
|
+
}), z.object({
|
|
1979
|
+
id: z.string(),
|
|
1980
|
+
name: otlpHeaderNameSchema,
|
|
1981
|
+
value: otlpHeaderValueSchema,
|
|
1982
|
+
isSecret: z.literal(false)
|
|
1983
|
+
})]);
|
|
1984
|
+
const telemetryDestinationOutputSchema = z.object({
|
|
1985
|
+
id: z.string(),
|
|
1986
|
+
signal: telemetrySignalSchema,
|
|
1987
|
+
endpoint: otlpEndpointSchema,
|
|
1988
|
+
protocol: otlpProtocolSchema,
|
|
1989
|
+
headers: z.array(telemetryDestinationHeaderOutputSchema),
|
|
1990
|
+
status: telemetryDestinationStatusSchema,
|
|
1991
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable(),
|
|
1992
|
+
isScopedToIntentionalRequestsOnly: z.boolean()
|
|
1993
|
+
});
|
|
1994
|
+
const createTelemetryDestinationHeaderInputSchema = z.object({
|
|
1995
|
+
name: otlpHeaderNameSchema,
|
|
1996
|
+
value: otlpHeaderValueSchema.min(1, "Enter a header value"),
|
|
1997
|
+
isSecret: z.boolean()
|
|
1998
|
+
});
|
|
1999
|
+
const updateTelemetryDestinationHeaderInputSchema = z.object({
|
|
2000
|
+
id: z.string().optional(),
|
|
2001
|
+
name: otlpHeaderNameSchema,
|
|
2002
|
+
value: otlpHeaderValueSchema.optional(),
|
|
2003
|
+
isSecret: z.boolean()
|
|
2004
|
+
});
|
|
2005
|
+
const uniqueTelemetryHeaders = (headers) => !hasDuplicateHeaderNames(headers);
|
|
2006
|
+
const listTelemetryDestinationsContractV1 = base.route({
|
|
2007
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations",
|
|
2008
|
+
method: "GET",
|
|
2009
|
+
summary: "List telemetry destinations",
|
|
2010
|
+
description: "List the OTLP destinations configured for an environment. Secret header values are never returned.",
|
|
2011
|
+
tags: ["telemetry"],
|
|
2012
|
+
successDescription: "The list of telemetry destinations"
|
|
2013
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(telemetryDestinationOutputSchema));
|
|
2014
|
+
const createTelemetryDestinationContractV1 = base.route({
|
|
2015
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations",
|
|
2016
|
+
method: "POST",
|
|
2017
|
+
summary: "Create a telemetry destination",
|
|
2018
|
+
description: "Verify and save an OTLP destination for logs, metrics, or traces.",
|
|
2019
|
+
tags: ["telemetry"],
|
|
2020
|
+
successDescription: "The telemetry destination has been created"
|
|
2021
|
+
}).errors({
|
|
2022
|
+
NOT_FOUND: {},
|
|
2023
|
+
FORBIDDEN: {},
|
|
2024
|
+
OTLP_DESTINATION_UNVERIFIED: { status: 400 },
|
|
2025
|
+
INTERNAL_SERVER_ERROR: {}
|
|
2026
|
+
}).input(z.object({
|
|
2027
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2028
|
+
signal: telemetrySignalSchema,
|
|
2029
|
+
endpoint: otlpEndpointSchema,
|
|
2030
|
+
protocol: otlpProtocolSchema.default("http/protobuf"),
|
|
2031
|
+
isScopedToIntentionalRequestsOnly: z.boolean().default(false),
|
|
2032
|
+
headers: z.array(createTelemetryDestinationHeaderInputSchema).default([]).refine(uniqueTelemetryHeaders, "Header names must be unique")
|
|
2033
|
+
})).output(telemetryDestinationOutputSchema);
|
|
2034
|
+
const updateTelemetryDestinationContractV1 = base.route({
|
|
2035
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations/{destinationId}",
|
|
2036
|
+
method: "PATCH",
|
|
2037
|
+
summary: "Update a telemetry destination",
|
|
2038
|
+
description: "Verify and save changes to an OTLP destination. Omit headers to keep them unchanged; omit the value of an existing header to preserve it. A secret header value must be re-entered when the endpoint changes.",
|
|
2039
|
+
tags: ["telemetry"],
|
|
2040
|
+
successDescription: "The telemetry destination has been updated"
|
|
2041
|
+
}).errors({
|
|
2042
|
+
NOT_FOUND: {},
|
|
2043
|
+
FORBIDDEN: {},
|
|
2044
|
+
OTLP_DESTINATION_UNVERIFIED: { status: 400 }
|
|
2045
|
+
}).input(z.object({
|
|
2046
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2047
|
+
destinationId: z.string().describe("The ID of the telemetry destination"),
|
|
2048
|
+
endpoint: otlpEndpointSchema.optional(),
|
|
2049
|
+
protocol: otlpProtocolSchema.optional(),
|
|
2050
|
+
isScopedToIntentionalRequestsOnly: z.boolean().optional(),
|
|
2051
|
+
headers: z.array(updateTelemetryDestinationHeaderInputSchema).refine(uniqueTelemetryHeaders, "Header names must be unique").optional()
|
|
2052
|
+
})).output(telemetryDestinationOutputSchema);
|
|
2053
|
+
const deleteTelemetryDestinationContractV1 = base.route({
|
|
2054
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations/{destinationId}",
|
|
2055
|
+
method: "DELETE",
|
|
2056
|
+
summary: "Delete a telemetry destination",
|
|
2057
|
+
description: "Delete an OTLP destination from an environment.",
|
|
2058
|
+
tags: ["telemetry"],
|
|
2059
|
+
successDescription: "The telemetry destination has been deleted"
|
|
2060
|
+
}).errors({
|
|
2061
|
+
NOT_FOUND: {},
|
|
2062
|
+
INTERNAL_SERVER_ERROR: {}
|
|
2063
|
+
}).input(z.object({
|
|
2064
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2065
|
+
destinationId: z.string().describe("The ID of the telemetry destination")
|
|
2066
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2067
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1507
2068
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1508
2069
|
method: "GET",
|
|
1509
2070
|
summary: "List environment variables",
|
|
@@ -1511,48 +2072,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1511
2072
|
tags: ["environments"],
|
|
1512
2073
|
successDescription: "The list of environment variables"
|
|
1513
2074
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1514
|
-
const createEnvironmentVariablesContractV1 =
|
|
2075
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1515
2076
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1516
2077
|
method: "POST",
|
|
1517
2078
|
summary: "Add environment variables",
|
|
1518
2079
|
description: "Add one or more environment variables to an environment",
|
|
1519
2080
|
tags: ["environments"],
|
|
1520
2081
|
successDescription: "The environment variables have been added successfully"
|
|
1521
|
-
}).errors({
|
|
1522
|
-
NOT_FOUND: {},
|
|
1523
|
-
BAD_REQUEST: {}
|
|
1524
|
-
}).input(z.object({
|
|
2082
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1525
2083
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1526
2084
|
environmentVariables: environmentVariablesSchema
|
|
1527
2085
|
})).output(z.object({ success: z.literal(true) }));
|
|
1528
|
-
const updateEnvironmentVariableContractV1 =
|
|
2086
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1529
2087
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1530
2088
|
method: "PATCH",
|
|
1531
2089
|
summary: "Update an environment variable",
|
|
1532
2090
|
description: "Update an environment variable by ID",
|
|
1533
2091
|
tags: ["environments"],
|
|
1534
2092
|
successDescription: "The environment variable has been updated successfully"
|
|
1535
|
-
}).errors({
|
|
1536
|
-
NOT_FOUND: {},
|
|
1537
|
-
BAD_REQUEST: {}
|
|
1538
|
-
}).input(z.object({
|
|
2093
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1539
2094
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1540
2095
|
key: environmentVariableSchema.shape.key,
|
|
1541
2096
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1542
2097
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1543
2098
|
})).output(z.object({ success: z.literal(true) }));
|
|
1544
|
-
const deleteEnvironmentVariableContractV1 =
|
|
2099
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1545
2100
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1546
2101
|
method: "DELETE",
|
|
1547
2102
|
summary: "Delete an environment variable",
|
|
1548
2103
|
description: "Delete an environment variable by ID",
|
|
1549
2104
|
tags: ["environments"],
|
|
1550
2105
|
successDescription: "The environment variable has been deleted successfully"
|
|
1551
|
-
}).errors({
|
|
1552
|
-
|
|
1553
|
-
BAD_REQUEST: {}
|
|
1554
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1555
|
-
const deleteProjectContractV1 = oc.route({
|
|
2106
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
2107
|
+
const deleteProjectContractV1 = base.route({
|
|
1556
2108
|
path: "/v1/projects/{projectId}",
|
|
1557
2109
|
method: "DELETE",
|
|
1558
2110
|
summary: "Delete a project",
|
|
@@ -1560,7 +2112,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1560
2112
|
tags: ["projects"],
|
|
1561
2113
|
successDescription: "The project has been deleted successfully"
|
|
1562
2114
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1563
|
-
const updateProjectContractV1 =
|
|
2115
|
+
const updateProjectContractV1 = base.route({
|
|
1564
2116
|
path: "/v1/projects/{projectId}",
|
|
1565
2117
|
method: "PATCH",
|
|
1566
2118
|
summary: "Update a project",
|
|
@@ -1569,14 +2121,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1569
2121
|
successDescription: "The project has been updated successfully"
|
|
1570
2122
|
}).errors({
|
|
1571
2123
|
NOT_FOUND: {},
|
|
1572
|
-
BAD_REQUEST: {},
|
|
1573
2124
|
FORBIDDEN: {}
|
|
1574
2125
|
}).input(z.object({
|
|
1575
2126
|
projectId: z.string().describe("The ID of the project"),
|
|
1576
2127
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1577
2128
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1578
2129
|
})).output(projectOutputSchema);
|
|
1579
|
-
const deployEnvironmentContractV1 =
|
|
2130
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1580
2131
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1581
2132
|
method: "POST",
|
|
1582
2133
|
summary: "Deploy an environment",
|
|
@@ -1585,29 +2136,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1585
2136
|
successDescription: "The environment has been deployed successfully"
|
|
1586
2137
|
}).errors({
|
|
1587
2138
|
NOT_FOUND: {},
|
|
1588
|
-
BAD_REQUEST: {},
|
|
1589
2139
|
CONFLICT: {}
|
|
1590
2140
|
}).input(z.object({
|
|
1591
2141
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1592
2142
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1593
2143
|
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.")
|
|
1594
2144
|
})).output(deploymentSchema);
|
|
1595
|
-
const uploadDeploymentArtifactContractV1 =
|
|
2145
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1596
2146
|
path: "/v1/deployments/upload",
|
|
1597
2147
|
method: "POST",
|
|
1598
2148
|
summary: "Upload deployment artifacts",
|
|
1599
2149
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1600
2150
|
tags: ["deployments"],
|
|
1601
2151
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1602
|
-
}).errors({
|
|
1603
|
-
NOT_FOUND: {},
|
|
1604
|
-
BAD_REQUEST: {}
|
|
1605
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
2152
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1606
2153
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1607
2154
|
token: z.string().describe("Token to identify the source archive"),
|
|
1608
2155
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1609
2156
|
}));
|
|
1610
|
-
const listDeploymentsContractV1 =
|
|
2157
|
+
const listDeploymentsContractV1 = base.route({
|
|
1611
2158
|
path: "/v1/projects/{projectId}/deployments",
|
|
1612
2159
|
method: "GET",
|
|
1613
2160
|
summary: "List project deployments",
|
|
@@ -1619,7 +2166,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1619
2166
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1620
2167
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1621
2168
|
})).output(z.array(deploymentSchema));
|
|
1622
|
-
const getDeploymentContractV1 =
|
|
2169
|
+
const getDeploymentContractV1 = base.route({
|
|
1623
2170
|
path: "/v1/deployments/{deploymentId}",
|
|
1624
2171
|
method: "GET",
|
|
1625
2172
|
summary: "Get a deployment",
|
|
@@ -1642,20 +2189,17 @@ const logEntrySchema = z.object({
|
|
|
1642
2189
|
method: z.string().optional(),
|
|
1643
2190
|
durationInMs: z.number().optional()
|
|
1644
2191
|
});
|
|
1645
|
-
const getLogsContractV1 =
|
|
2192
|
+
const getLogsContractV1 = base.route({
|
|
1646
2193
|
path: "/v1/environments/{environmentId}/logs",
|
|
1647
2194
|
method: "GET",
|
|
1648
2195
|
summary: "Get logs",
|
|
1649
2196
|
description: "Get logs for an environment",
|
|
1650
2197
|
tags: ["environments"],
|
|
1651
2198
|
successDescription: "The logs"
|
|
1652
|
-
}).errors({
|
|
1653
|
-
NOT_FOUND: {},
|
|
1654
|
-
BAD_REQUEST: {}
|
|
1655
|
-
}).input(z.object({
|
|
2199
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1656
2200
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1657
|
-
since:
|
|
1658
|
-
until:
|
|
2201
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2202
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1659
2203
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1660
2204
|
level: z.array(z.enum([
|
|
1661
2205
|
"INFO",
|
|
@@ -1663,23 +2207,20 @@ const getLogsContractV1 = oc.route({
|
|
|
1663
2207
|
"WARNING",
|
|
1664
2208
|
"DEBUG"
|
|
1665
2209
|
])).optional().describe("Filter by log level"),
|
|
1666
|
-
search:
|
|
2210
|
+
search: logSearchSchema.optional().describe("Term to search for in log content"),
|
|
1667
2211
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1668
2212
|
})).output(z.object({
|
|
1669
2213
|
logs: z.array(logEntrySchema),
|
|
1670
2214
|
nextToken: z.string().nullable()
|
|
1671
2215
|
}));
|
|
1672
|
-
const getLatestLogsContractV1 =
|
|
2216
|
+
const getLatestLogsContractV1 = base.route({
|
|
1673
2217
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1674
2218
|
method: "GET",
|
|
1675
2219
|
summary: "Get latest logs",
|
|
1676
2220
|
description: "Get the N most recent logs for an environment",
|
|
1677
2221
|
tags: ["environments"],
|
|
1678
2222
|
successDescription: "The latest logs"
|
|
1679
|
-
}).errors({
|
|
1680
|
-
NOT_FOUND: {},
|
|
1681
|
-
BAD_REQUEST: {}
|
|
1682
|
-
}).input(z.object({
|
|
2223
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1683
2224
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1684
2225
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1685
2226
|
level: z.array(z.enum([
|
|
@@ -1688,9 +2229,9 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1688
2229
|
"WARNING",
|
|
1689
2230
|
"DEBUG"
|
|
1690
2231
|
])).optional().describe("Filter by log level"),
|
|
1691
|
-
search:
|
|
2232
|
+
search: logSearchSchema.optional().describe("Term to search for in log content")
|
|
1692
2233
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1693
|
-
const getDeploymentLogsContractV1 =
|
|
2234
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1694
2235
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1695
2236
|
method: "GET",
|
|
1696
2237
|
summary: "Get deployment logs",
|
|
@@ -1717,22 +2258,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1717
2258
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1718
2259
|
task_count: z.array(analyticsDataPointSchema)
|
|
1719
2260
|
});
|
|
1720
|
-
const getProjectAnalyticsContractV1 =
|
|
2261
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1721
2262
|
path: "/v1/analytics/{projectId}",
|
|
1722
2263
|
method: "GET",
|
|
1723
2264
|
summary: "Get project analytics",
|
|
1724
2265
|
description: "Get analytics data for a project over a time range",
|
|
1725
2266
|
tags: ["analytics"],
|
|
1726
2267
|
successDescription: "The project analytics data"
|
|
1727
|
-
}).errors({
|
|
1728
|
-
NOT_FOUND: {},
|
|
1729
|
-
BAD_REQUEST: {}
|
|
1730
|
-
}).input(z.object({
|
|
2268
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1731
2269
|
projectId: z.string().describe("The ID of the project"),
|
|
1732
2270
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1733
2271
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1734
2272
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1735
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2273
|
+
}).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({
|
|
1736
2274
|
metadata: z.object({
|
|
1737
2275
|
startTimestamp: z.number(),
|
|
1738
2276
|
endTimestamp: z.number(),
|
|
@@ -1742,7 +2280,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1742
2280
|
}),
|
|
1743
2281
|
timeSeries: analyticsTimeSeriesSchema
|
|
1744
2282
|
}));
|
|
1745
|
-
const
|
|
2283
|
+
const paginatedInsightsInputShape = {
|
|
2284
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2285
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2286
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2287
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2288
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2289
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2290
|
+
};
|
|
2291
|
+
const listIntentsContractV1 = base.route({
|
|
2292
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2293
|
+
method: "GET",
|
|
2294
|
+
summary: "List intents",
|
|
2295
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2296
|
+
tags: ["insights"],
|
|
2297
|
+
successDescription: "The grouped user intents"
|
|
2298
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2299
|
+
...paginatedInsightsInputShape,
|
|
2300
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2301
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2302
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2303
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2304
|
+
})).output(z.object({
|
|
2305
|
+
intents: z.array(z.object({
|
|
2306
|
+
id: z.string(),
|
|
2307
|
+
intentIds: z.array(z.string()).min(1),
|
|
2308
|
+
environmentId: z.string(),
|
|
2309
|
+
message: z.string(),
|
|
2310
|
+
toolName: z.string(),
|
|
2311
|
+
createdAt: z.coerce.date(),
|
|
2312
|
+
occurrenceCount: z.number().int().positive(),
|
|
2313
|
+
clientName: z.string().nullable(),
|
|
2314
|
+
clientId: z.string().nullable(),
|
|
2315
|
+
categories: z.array(z.object({
|
|
2316
|
+
id: z.string(),
|
|
2317
|
+
name: z.string(),
|
|
2318
|
+
color: intentCategoryColorSchema
|
|
2319
|
+
}))
|
|
2320
|
+
})),
|
|
2321
|
+
totalCount: z.number().int().nonnegative()
|
|
2322
|
+
}));
|
|
2323
|
+
const listFeedbacksContractV1 = base.route({
|
|
2324
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2325
|
+
method: "GET",
|
|
2326
|
+
summary: "List feedbacks",
|
|
2327
|
+
description: "List user feedback for an environment over a time range",
|
|
2328
|
+
tags: ["insights"],
|
|
2329
|
+
successDescription: "The user feedback"
|
|
2330
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2331
|
+
...paginatedInsightsInputShape,
|
|
2332
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2333
|
+
})).output(z.object({
|
|
2334
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2335
|
+
totalCount: z.number().int().nonnegative()
|
|
2336
|
+
}));
|
|
2337
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2338
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2339
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2340
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2341
|
+
method: "GET",
|
|
2342
|
+
summary: "List intent categories",
|
|
2343
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2344
|
+
tags: ["insights"],
|
|
2345
|
+
successDescription: "The intent categories"
|
|
2346
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2347
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2348
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2349
|
+
method: "POST",
|
|
2350
|
+
summary: "Create an intent category",
|
|
2351
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2352
|
+
tags: ["insights"],
|
|
2353
|
+
successDescription: "The created intent category"
|
|
2354
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2355
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2356
|
+
name: intentCategoryNameSchema,
|
|
2357
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2358
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2359
|
+
})).output(intentCategorySchema);
|
|
2360
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2361
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2362
|
+
method: "PATCH",
|
|
2363
|
+
summary: "Update an intent category",
|
|
2364
|
+
description: "Rename or recolor an intent category",
|
|
2365
|
+
tags: ["insights"],
|
|
2366
|
+
successDescription: "The updated intent category"
|
|
2367
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2368
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2369
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2370
|
+
name: intentCategoryNameSchema.optional(),
|
|
2371
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2372
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2373
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2374
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2375
|
+
method: "DELETE",
|
|
2376
|
+
summary: "Delete an intent category",
|
|
2377
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2378
|
+
tags: ["insights"],
|
|
2379
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2380
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2381
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2382
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2383
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2384
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2385
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2386
|
+
method: "POST",
|
|
2387
|
+
summary: "Link an intent category",
|
|
2388
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2389
|
+
tags: ["insights"],
|
|
2390
|
+
successDescription: "The intents have been linked successfully"
|
|
2391
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2392
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2393
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2394
|
+
intentIds: categorizableIntentIdsSchema
|
|
2395
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2396
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2397
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2398
|
+
method: "POST",
|
|
2399
|
+
summary: "Unlink an intent category",
|
|
2400
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2401
|
+
tags: ["insights"],
|
|
2402
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2403
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2404
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2405
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2406
|
+
intentIds: categorizableIntentIdsSchema
|
|
2407
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2408
|
+
const listTeamsContractV1 = base.route({
|
|
1746
2409
|
path: "/v1/teams",
|
|
1747
2410
|
method: "GET",
|
|
1748
2411
|
summary: "List teams",
|
|
@@ -1755,7 +2418,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1755
2418
|
createdAt: z.coerce.date(),
|
|
1756
2419
|
hasStripeAccount: z.boolean()
|
|
1757
2420
|
})));
|
|
1758
|
-
const
|
|
2421
|
+
const getTeamUsageContractV1 = base.route({
|
|
2422
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2423
|
+
method: "GET",
|
|
2424
|
+
summary: "Get team usage",
|
|
2425
|
+
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.",
|
|
2426
|
+
tags: ["teams"],
|
|
2427
|
+
successDescription: "The current billing window usage"
|
|
2428
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2429
|
+
teamId: z.string(),
|
|
2430
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2431
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2432
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2433
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2434
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2435
|
+
}));
|
|
2436
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1759
2437
|
path: "/v1/tunnels/ticket",
|
|
1760
2438
|
method: "GET",
|
|
1761
2439
|
summary: "Get a tunnel ticket",
|
|
@@ -1767,16 +2445,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1767
2445
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1768
2446
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1769
2447
|
}));
|
|
1770
|
-
const publishServerContractV1 =
|
|
2448
|
+
const publishServerContractV1 = base.route({
|
|
1771
2449
|
path: "/v1/distribution/publish",
|
|
1772
2450
|
method: "POST",
|
|
1773
2451
|
summary: "Publish a server to the MCP registry",
|
|
1774
2452
|
tags: ["distribution"],
|
|
1775
2453
|
successDescription: "The server has been published successfully"
|
|
1776
|
-
}).errors({
|
|
1777
|
-
NOT_FOUND: {},
|
|
1778
|
-
BAD_REQUEST: {}
|
|
1779
|
-
}).input(z.object({
|
|
2454
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1780
2455
|
projectId: z.string(),
|
|
1781
2456
|
domain: z.string(),
|
|
1782
2457
|
title: z.string().min(1).max(100),
|
|
@@ -1785,17 +2460,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1785
2460
|
iconSrc: z.url().max(255).optional(),
|
|
1786
2461
|
dryRun: z.boolean().optional()
|
|
1787
2462
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1788
|
-
const getServerInfoContractV1 =
|
|
2463
|
+
const getServerInfoContractV1 = base.route({
|
|
1789
2464
|
path: "/v1/distribution/get",
|
|
1790
2465
|
method: "GET",
|
|
1791
2466
|
summary: "Get server info",
|
|
1792
2467
|
description: "Get info about a server",
|
|
1793
2468
|
tags: ["distribution"],
|
|
1794
2469
|
successDescription: "The server info"
|
|
1795
|
-
}).errors({
|
|
1796
|
-
NOT_FOUND: {},
|
|
1797
|
-
BAD_REQUEST: {}
|
|
1798
|
-
}).input(z.object({
|
|
2470
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1799
2471
|
projectId: z.string(),
|
|
1800
2472
|
domain: z.string()
|
|
1801
2473
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1814,7 +2486,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1814
2486
|
isPlaygroundEnabled: z.boolean(),
|
|
1815
2487
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1816
2488
|
});
|
|
1817
|
-
const getPlaygroundContractV1 =
|
|
2489
|
+
const getPlaygroundContractV1 = base.route({
|
|
1818
2490
|
path: "/v1/environments/{environmentId}/playground",
|
|
1819
2491
|
method: "GET",
|
|
1820
2492
|
summary: "Get playground configuration",
|
|
@@ -1822,17 +2494,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1822
2494
|
tags: ["environments"],
|
|
1823
2495
|
successDescription: "The playground configuration"
|
|
1824
2496
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1825
|
-
const upsertPlaygroundContractV1 =
|
|
2497
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1826
2498
|
path: "/v1/environments/{environmentId}/playground",
|
|
1827
2499
|
method: "PUT",
|
|
1828
2500
|
summary: "Update playground configuration",
|
|
1829
2501
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1830
2502
|
tags: ["environments"],
|
|
1831
2503
|
successDescription: "The updated playground configuration"
|
|
1832
|
-
}).errors({
|
|
1833
|
-
NOT_FOUND: {},
|
|
1834
|
-
BAD_REQUEST: {}
|
|
1835
|
-
}).input(z.object({
|
|
2504
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1836
2505
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1837
2506
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1838
2507
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1840,7 +2509,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1840
2509
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1841
2510
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1842
2511
|
})).output(playgroundOutputSchema);
|
|
1843
|
-
const createBeaconContractV1 =
|
|
2512
|
+
const createBeaconContractV1 = base.route({
|
|
1844
2513
|
path: "/v1/beacon/audits",
|
|
1845
2514
|
method: "POST",
|
|
1846
2515
|
summary: "Create a beacon audit",
|
|
@@ -1849,7 +2518,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1849
2518
|
successDescription: "The audit has been created"
|
|
1850
2519
|
}).errors({
|
|
1851
2520
|
NOT_FOUND: {},
|
|
1852
|
-
BAD_REQUEST: {},
|
|
1853
2521
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1854
2522
|
}).input(z.object({
|
|
1855
2523
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1857,7 +2525,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1857
2525
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1858
2526
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1859
2527
|
})).output(z.object({ id: z.string() }));
|
|
1860
|
-
const getBeaconContractV1 =
|
|
2528
|
+
const getBeaconContractV1 = base.route({
|
|
1861
2529
|
path: "/v1/beacon/audits/{auditId}",
|
|
1862
2530
|
method: "GET",
|
|
1863
2531
|
summary: "Get a beacon audit",
|
|
@@ -1872,9 +2540,73 @@ const getBeaconContractV1 = oc.route({
|
|
|
1872
2540
|
createdAt: z.coerce.date(),
|
|
1873
2541
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1874
2542
|
}));
|
|
2543
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2544
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2545
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2546
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2547
|
+
const createSubmissionContractV1 = base.route({
|
|
2548
|
+
path: "/v1/submissions",
|
|
2549
|
+
method: "POST",
|
|
2550
|
+
summary: "Create a submission package",
|
|
2551
|
+
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.",
|
|
2552
|
+
tags: ["submissions"],
|
|
2553
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2554
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2555
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2556
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2557
|
+
})).output(submissionSchema);
|
|
2558
|
+
const listSubmissionsContractV1 = base.route({
|
|
2559
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2560
|
+
method: "GET",
|
|
2561
|
+
summary: "List submission packages",
|
|
2562
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2563
|
+
tags: ["submissions"],
|
|
2564
|
+
successDescription: "The list of submission packages"
|
|
2565
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2566
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2567
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2568
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2569
|
+
})).output(z.array(submissionSchema));
|
|
2570
|
+
const getSubmissionContractV1 = base.route({
|
|
2571
|
+
path: "/v1/submissions/{submissionId}",
|
|
2572
|
+
method: "GET",
|
|
2573
|
+
summary: "Get a submission package",
|
|
2574
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2575
|
+
tags: ["submissions"],
|
|
2576
|
+
successDescription: "The submission package"
|
|
2577
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2578
|
+
const updateSubmissionContractV1 = base.route({
|
|
2579
|
+
path: "/v1/submissions/{submissionId}",
|
|
2580
|
+
method: "PUT",
|
|
2581
|
+
summary: "Update a submission package",
|
|
2582
|
+
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.",
|
|
2583
|
+
tags: ["submissions"],
|
|
2584
|
+
successDescription: "The updated submission package"
|
|
2585
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2586
|
+
submissionId: submissionIdSchema,
|
|
2587
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2588
|
+
formData: claudeSubmissionUpdateSchema
|
|
2589
|
+
}), z.object({
|
|
2590
|
+
submissionId: submissionIdSchema,
|
|
2591
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2592
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2593
|
+
})])).output(submissionSchema);
|
|
1875
2594
|
const contract = {
|
|
1876
|
-
teams: {
|
|
2595
|
+
teams: {
|
|
2596
|
+
list: { v1: listTeamsContractV1 },
|
|
2597
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2598
|
+
},
|
|
1877
2599
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2600
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2601
|
+
intentCategories: {
|
|
2602
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2603
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2604
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2605
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2606
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2607
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2608
|
+
},
|
|
2609
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1878
2610
|
deployments: {
|
|
1879
2611
|
list: { v1: listDeploymentsContractV1 },
|
|
1880
2612
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1884,6 +2616,7 @@ const contract = {
|
|
|
1884
2616
|
environments: {
|
|
1885
2617
|
create: { v1: createEnvironmentContractV1 },
|
|
1886
2618
|
get: { v1: getEnvironmentContractV1 },
|
|
2619
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1887
2620
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1888
2621
|
getLogs: { v1: getLogsContractV1 },
|
|
1889
2622
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1894,6 +2627,12 @@ const contract = {
|
|
|
1894
2627
|
update: { v1: updateEnvironmentVariableContractV1 },
|
|
1895
2628
|
delete: { v1: deleteEnvironmentVariableContractV1 }
|
|
1896
2629
|
},
|
|
2630
|
+
telemetryDestinations: {
|
|
2631
|
+
list: { v1: listTelemetryDestinationsContractV1 },
|
|
2632
|
+
create: { v1: createTelemetryDestinationContractV1 },
|
|
2633
|
+
update: { v1: updateTelemetryDestinationContractV1 },
|
|
2634
|
+
delete: { v1: deleteTelemetryDestinationContractV1 }
|
|
2635
|
+
},
|
|
1897
2636
|
projects: {
|
|
1898
2637
|
update: { v1: updateProjectContractV1 },
|
|
1899
2638
|
get: { v1: getProjectContractV1 },
|
|
@@ -1913,7 +2652,39 @@ const contract = {
|
|
|
1913
2652
|
beacon: {
|
|
1914
2653
|
create: { v1: createBeaconContractV1 },
|
|
1915
2654
|
get: { v1: getBeaconContractV1 }
|
|
2655
|
+
},
|
|
2656
|
+
submissions: {
|
|
2657
|
+
create: { v1: createSubmissionContractV1 },
|
|
2658
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2659
|
+
get: { v1: getSubmissionContractV1 },
|
|
2660
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2661
|
+
}
|
|
2662
|
+
};
|
|
2663
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2664
|
+
const contractForDocs = {
|
|
2665
|
+
...contract,
|
|
2666
|
+
deployments: deploymentsForDocs
|
|
2667
|
+
};
|
|
2668
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2669
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2670
|
+
info: {
|
|
2671
|
+
title: "Alpic API",
|
|
2672
|
+
version: "1.0.0"
|
|
2673
|
+
},
|
|
2674
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2675
|
+
security: [{ bearerAuth: [] }],
|
|
2676
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2677
|
+
type: "http",
|
|
2678
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2679
|
+
scheme: "bearer"
|
|
2680
|
+
} } },
|
|
2681
|
+
commonSchemas: {
|
|
2682
|
+
Submission: { schema: submissionSchema },
|
|
2683
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2684
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2685
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2686
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
1916
2687
|
}
|
|
1917
2688
|
};
|
|
1918
2689
|
//#endregion
|
|
1919
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2690
|
+
export { AI_PLATFORMS, AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, OPENAPI_DOC_OPTIONS, OTLP_PROTOCOLS, PLATFORM_LABELS, TELEMETRY_SIGNALS, buildSettingsSchema, chatgptSubmissionUpdateSchema, claudeSubmissionUpdateSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, detectPythonRuntimeFromRequirement, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, otlpProtocolSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, telemetrySignalSchema, transportSchema, updateEnvironmentVariableSchema };
|