@alpic-ai/api 0.0.0-dev.ge364046 → 0.0.0-dev.ge3af456
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 +5433 -145
- package/dist/index.mjs +746 -113
- package/package.json +9 -9
package/dist/index.mjs
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
import * as z$1 from "zod/v4";
|
|
3
3
|
import { oc } from "@orpc/contract";
|
|
4
4
|
import ms from "ms";
|
|
5
|
-
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.1_supports-color@7.2.0_zod@4.5.4/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -179,6 +179,7 @@ const PLATFORM_LABELS = {
|
|
|
179
179
|
};
|
|
180
180
|
const WAF_PLATFORMS = [
|
|
181
181
|
"akamai",
|
|
182
|
+
"cato",
|
|
182
183
|
"cloudflare",
|
|
183
184
|
"fastly"
|
|
184
185
|
];
|
|
@@ -256,6 +257,25 @@ z.object({
|
|
|
256
257
|
clientSecret: z.string(),
|
|
257
258
|
clientScopes: z.array(z.string())
|
|
258
259
|
});
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"admin_adjustment"
|
|
266
|
+
]);
|
|
267
|
+
z.enum(["playground"]);
|
|
268
|
+
z.number().int().min(500);
|
|
269
|
+
const creditActivityEntrySchema = z.object({
|
|
270
|
+
reason: creditEntryReasonSchema,
|
|
271
|
+
day: z.number(),
|
|
272
|
+
amountInNanoUSD: z.number(),
|
|
273
|
+
messageCount: z.number().nullable()
|
|
274
|
+
});
|
|
275
|
+
z.object({
|
|
276
|
+
balanceInNanoUSD: z.number(),
|
|
277
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
278
|
+
});
|
|
259
279
|
const deploymentStatusSchema$1 = z.enum([
|
|
260
280
|
"ongoing",
|
|
261
281
|
"deployed",
|
|
@@ -400,14 +420,16 @@ z.object({
|
|
|
400
420
|
collectResponsePayload: z.boolean(),
|
|
401
421
|
collectErrorMessage: z.boolean(),
|
|
402
422
|
collectUserData: z.boolean(),
|
|
403
|
-
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
423
|
+
identityTraitKey: z.string().min(1).max(200).nullable(),
|
|
424
|
+
leadEventName: z.string().min(1).max(200).nullable()
|
|
404
425
|
});
|
|
405
|
-
z.object({
|
|
426
|
+
const feedbackSchema = z.object({
|
|
406
427
|
id: z.string(),
|
|
407
428
|
createdAt: z.coerce.date(),
|
|
408
429
|
environmentId: z.string(),
|
|
409
430
|
content: z.string(),
|
|
410
|
-
source: z.enum(["model", "user"])
|
|
431
|
+
source: z.enum(["model", "user"]),
|
|
432
|
+
clientName: z.string().nullable()
|
|
411
433
|
});
|
|
412
434
|
z.object({
|
|
413
435
|
content: z.string(),
|
|
@@ -423,7 +445,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
423
445
|
"pink",
|
|
424
446
|
"gray"
|
|
425
447
|
]);
|
|
426
|
-
intentCategoryColorSchema.options;
|
|
448
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
427
449
|
const intentCategorySchema = z.object({
|
|
428
450
|
id: z.string(),
|
|
429
451
|
createdAt: z.coerce.date(),
|
|
@@ -431,7 +453,7 @@ const intentCategorySchema = z.object({
|
|
|
431
453
|
name: z.string(),
|
|
432
454
|
color: intentCategoryColorSchema
|
|
433
455
|
});
|
|
434
|
-
z.object({
|
|
456
|
+
const intentCategorySummarySchema = z.object({
|
|
435
457
|
id: z.string(),
|
|
436
458
|
name: z.string(),
|
|
437
459
|
color: intentCategoryColorSchema,
|
|
@@ -443,6 +465,7 @@ z.object({
|
|
|
443
465
|
environmentId: z.string(),
|
|
444
466
|
toolName: z.string(),
|
|
445
467
|
message: z.string(),
|
|
468
|
+
clientName: z.string().nullable(),
|
|
446
469
|
categories: z.array(intentCategorySchema)
|
|
447
470
|
});
|
|
448
471
|
const signalCategorySchema = z.object({
|
|
@@ -501,12 +524,262 @@ z.object({
|
|
|
501
524
|
createdAt: z.coerce.date(),
|
|
502
525
|
updatedAt: z.coerce.date()
|
|
503
526
|
});
|
|
527
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
528
|
+
type: z.literal("mcp_request"),
|
|
529
|
+
method: z.string()
|
|
530
|
+
});
|
|
531
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
532
|
+
type: z.literal("mcp_error"),
|
|
533
|
+
method: z.string(),
|
|
534
|
+
error: z.string()
|
|
535
|
+
});
|
|
536
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
504
537
|
z.enum([
|
|
505
538
|
"INFO",
|
|
506
539
|
"WARNING",
|
|
507
540
|
"DEBUG",
|
|
508
541
|
"ERROR"
|
|
509
542
|
]);
|
|
543
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
544
|
+
const MCP_CLIENT_GROUPS = [
|
|
545
|
+
{
|
|
546
|
+
id: "claude_code",
|
|
547
|
+
label: "Claude Code",
|
|
548
|
+
vendor: "anthropic",
|
|
549
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
550
|
+
},
|
|
551
|
+
{
|
|
552
|
+
id: "claude",
|
|
553
|
+
label: "Claude",
|
|
554
|
+
vendor: "anthropic",
|
|
555
|
+
rawNames: [
|
|
556
|
+
"Anthropic/ClaudeAI",
|
|
557
|
+
"claude-ai",
|
|
558
|
+
"claude",
|
|
559
|
+
"Claude",
|
|
560
|
+
"claude-desktop",
|
|
561
|
+
"claude-desktop-3p"
|
|
562
|
+
]
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
id: "claude_mobile",
|
|
566
|
+
label: "Claude mobile",
|
|
567
|
+
vendor: "anthropic",
|
|
568
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
569
|
+
},
|
|
570
|
+
{
|
|
571
|
+
id: "claude_cowork",
|
|
572
|
+
label: "Claude Cowork",
|
|
573
|
+
vendor: "anthropic",
|
|
574
|
+
rawNames: ["Anthropic/Cowork"]
|
|
575
|
+
},
|
|
576
|
+
{
|
|
577
|
+
id: "claude_toolbox",
|
|
578
|
+
label: "Claude Toolbox",
|
|
579
|
+
vendor: "anthropic",
|
|
580
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
581
|
+
},
|
|
582
|
+
{
|
|
583
|
+
id: "anthropic_api",
|
|
584
|
+
label: "Anthropic API",
|
|
585
|
+
vendor: "anthropic",
|
|
586
|
+
rawNames: ["Anthropic/API"]
|
|
587
|
+
},
|
|
588
|
+
{
|
|
589
|
+
id: "anthropic_connector_refresh",
|
|
590
|
+
label: "Anthropic (connector refresh)",
|
|
591
|
+
vendor: "anthropic",
|
|
592
|
+
rawNames: ["Anthropic"]
|
|
593
|
+
},
|
|
594
|
+
{
|
|
595
|
+
id: "codex",
|
|
596
|
+
label: "Codex",
|
|
597
|
+
vendor: "openai",
|
|
598
|
+
rawNames: [
|
|
599
|
+
"codex-mcp-client",
|
|
600
|
+
"codex",
|
|
601
|
+
"Codex",
|
|
602
|
+
"codex-cli",
|
|
603
|
+
"openai-mcp (Codex)"
|
|
604
|
+
]
|
|
605
|
+
},
|
|
606
|
+
{
|
|
607
|
+
id: "chatgpt",
|
|
608
|
+
label: "ChatGPT",
|
|
609
|
+
vendor: "openai",
|
|
610
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
611
|
+
},
|
|
612
|
+
{
|
|
613
|
+
id: "openai_responses_api",
|
|
614
|
+
label: "OpenAI Responses API",
|
|
615
|
+
vendor: "openai",
|
|
616
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
617
|
+
},
|
|
618
|
+
{
|
|
619
|
+
id: "openai_agent_builder",
|
|
620
|
+
label: "OpenAI Agent Builder",
|
|
621
|
+
vendor: "openai",
|
|
622
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
623
|
+
},
|
|
624
|
+
{
|
|
625
|
+
id: "openai_other",
|
|
626
|
+
label: "OpenAI Other",
|
|
627
|
+
vendor: "openai",
|
|
628
|
+
rawNames: ["openai-mcp"]
|
|
629
|
+
},
|
|
630
|
+
{
|
|
631
|
+
id: "cursor",
|
|
632
|
+
label: "Cursor",
|
|
633
|
+
vendor: "cursor",
|
|
634
|
+
rawNames: [
|
|
635
|
+
"cursor-vscode",
|
|
636
|
+
"Cursor",
|
|
637
|
+
"cursor"
|
|
638
|
+
]
|
|
639
|
+
},
|
|
640
|
+
{
|
|
641
|
+
id: "cline",
|
|
642
|
+
label: "Cline",
|
|
643
|
+
vendor: "cline",
|
|
644
|
+
rawNames: [
|
|
645
|
+
"Cline",
|
|
646
|
+
"cline",
|
|
647
|
+
"@cline/core"
|
|
648
|
+
]
|
|
649
|
+
},
|
|
650
|
+
{
|
|
651
|
+
id: "github_copilot",
|
|
652
|
+
label: "GitHub Copilot",
|
|
653
|
+
vendor: "githubCopilot",
|
|
654
|
+
rawNames: [
|
|
655
|
+
"Copilot",
|
|
656
|
+
"github-copilot-developer",
|
|
657
|
+
"Copilot MCP Gateway",
|
|
658
|
+
"Xcode/copilot-xcode"
|
|
659
|
+
]
|
|
660
|
+
},
|
|
661
|
+
{
|
|
662
|
+
id: "gemini_cli",
|
|
663
|
+
label: "Gemini CLI",
|
|
664
|
+
vendor: "google",
|
|
665
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
666
|
+
},
|
|
667
|
+
{
|
|
668
|
+
id: "antigravity",
|
|
669
|
+
label: "Antigravity",
|
|
670
|
+
vendor: "google",
|
|
671
|
+
rawNames: ["antigravity-client"]
|
|
672
|
+
},
|
|
673
|
+
{
|
|
674
|
+
id: "gemini",
|
|
675
|
+
label: "Gemini",
|
|
676
|
+
vendor: "google",
|
|
677
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
678
|
+
},
|
|
679
|
+
{
|
|
680
|
+
id: "windsurf",
|
|
681
|
+
label: "Windsurf",
|
|
682
|
+
vendor: "windsurf",
|
|
683
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
684
|
+
},
|
|
685
|
+
{
|
|
686
|
+
id: "mistral",
|
|
687
|
+
label: "Mistral / Le Chat",
|
|
688
|
+
vendor: "mistral",
|
|
689
|
+
rawNames: ["Mistral"],
|
|
690
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
691
|
+
},
|
|
692
|
+
{
|
|
693
|
+
id: "n8n",
|
|
694
|
+
label: "n8n",
|
|
695
|
+
vendor: "n8n",
|
|
696
|
+
rawNames: [
|
|
697
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
698
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
699
|
+
"n8n"
|
|
700
|
+
]
|
|
701
|
+
},
|
|
702
|
+
{
|
|
703
|
+
id: "alpic_playground",
|
|
704
|
+
label: "Alpic Playground",
|
|
705
|
+
vendor: "alpic",
|
|
706
|
+
rawNames: ["alpic-playground", "playground"]
|
|
707
|
+
},
|
|
708
|
+
{
|
|
709
|
+
id: "opencode",
|
|
710
|
+
label: "opencode",
|
|
711
|
+
vendor: "opencode",
|
|
712
|
+
rawNames: ["opencode"]
|
|
713
|
+
},
|
|
714
|
+
{
|
|
715
|
+
id: "zed",
|
|
716
|
+
label: "Zed",
|
|
717
|
+
vendor: "zed",
|
|
718
|
+
rawNames: ["Zed", "zed"]
|
|
719
|
+
},
|
|
720
|
+
{
|
|
721
|
+
id: "zapier",
|
|
722
|
+
label: "Zapier",
|
|
723
|
+
vendor: "zapier",
|
|
724
|
+
rawNames: ["Zapier", "zapier"]
|
|
725
|
+
},
|
|
726
|
+
{
|
|
727
|
+
id: "make",
|
|
728
|
+
label: "Make",
|
|
729
|
+
vendor: "make",
|
|
730
|
+
rawNames: ["Make", "make"]
|
|
731
|
+
},
|
|
732
|
+
{
|
|
733
|
+
id: "librechat",
|
|
734
|
+
label: "LibreChat",
|
|
735
|
+
vendor: "mcp",
|
|
736
|
+
rawNames: ["LibreChat", "librechat"]
|
|
737
|
+
},
|
|
738
|
+
{
|
|
739
|
+
id: "jan",
|
|
740
|
+
label: "Jan",
|
|
741
|
+
vendor: "mcp",
|
|
742
|
+
rawNames: ["Jan", "jan"]
|
|
743
|
+
},
|
|
744
|
+
{
|
|
745
|
+
id: "goose",
|
|
746
|
+
label: "goose",
|
|
747
|
+
vendor: "mcp",
|
|
748
|
+
rawNames: ["goose", "Goose"]
|
|
749
|
+
},
|
|
750
|
+
{
|
|
751
|
+
id: "mcphost",
|
|
752
|
+
label: "mcphost",
|
|
753
|
+
vendor: "mcp",
|
|
754
|
+
rawNames: ["mcphost"]
|
|
755
|
+
},
|
|
756
|
+
{
|
|
757
|
+
id: "mcporter",
|
|
758
|
+
label: "mcporter",
|
|
759
|
+
vendor: "mcp",
|
|
760
|
+
rawNames: ["mcporter"]
|
|
761
|
+
},
|
|
762
|
+
{
|
|
763
|
+
id: "rmcp",
|
|
764
|
+
label: "rmcp",
|
|
765
|
+
vendor: "mcp",
|
|
766
|
+
rawNames: ["rmcp"]
|
|
767
|
+
},
|
|
768
|
+
{
|
|
769
|
+
id: "unnamed_client",
|
|
770
|
+
label: "Unnamed client",
|
|
771
|
+
vendor: "mcp",
|
|
772
|
+
rawNames: [
|
|
773
|
+
"mcp",
|
|
774
|
+
"unknown",
|
|
775
|
+
""
|
|
776
|
+
]
|
|
777
|
+
}
|
|
778
|
+
];
|
|
779
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
780
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
781
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
782
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
510
783
|
const runtimeSchema = z.enum([
|
|
511
784
|
"python3.13",
|
|
512
785
|
"python3.14",
|
|
@@ -592,6 +865,10 @@ const clampStringField = (field) => {
|
|
|
592
865
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
593
866
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
594
867
|
};
|
|
868
|
+
const unboundedArrayField = (field) => {
|
|
869
|
+
const unbounded = z.array(field.element);
|
|
870
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
871
|
+
};
|
|
595
872
|
const toolDefinitionSchema = z.object({
|
|
596
873
|
name: z.string(),
|
|
597
874
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -604,11 +881,22 @@ const toolDefinitionSchema = z.object({
|
|
|
604
881
|
}).optional()
|
|
605
882
|
});
|
|
606
883
|
const positiveTestCaseSchema = z.object({
|
|
607
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
608
|
-
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."),
|
|
884
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
885
|
+
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."),
|
|
609
886
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
610
887
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
611
|
-
}).
|
|
888
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
889
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
890
|
+
scenario: z.string().optional(),
|
|
891
|
+
userPrompt: z.string().optional()
|
|
892
|
+
});
|
|
893
|
+
const blankPositiveTestCase = () => ({
|
|
894
|
+
scenario: "",
|
|
895
|
+
userPrompt: "",
|
|
896
|
+
toolTriggered: "",
|
|
897
|
+
expectedOutput: ""
|
|
898
|
+
});
|
|
899
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
612
900
|
const screenshotEntrySchema = z.object({
|
|
613
901
|
prompt: z.string(),
|
|
614
902
|
url: z.url()
|
|
@@ -921,9 +1209,18 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
921
1209
|
"zh-TW"
|
|
922
1210
|
]);
|
|
923
1211
|
const negativeTestCaseSchema = z.object({
|
|
924
|
-
scenario: z.string(),
|
|
925
|
-
userPrompt: z.string()
|
|
926
|
-
}).
|
|
1212
|
+
scenario: z.string().min(1),
|
|
1213
|
+
userPrompt: z.string().min(1)
|
|
1214
|
+
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1215
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1216
|
+
scenario: z.string().optional(),
|
|
1217
|
+
userPrompt: z.string().optional()
|
|
1218
|
+
});
|
|
1219
|
+
const blankNegativeTestCase = () => ({
|
|
1220
|
+
scenario: "",
|
|
1221
|
+
userPrompt: ""
|
|
1222
|
+
});
|
|
1223
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
927
1224
|
const chatgptToolJustificationSchema = z.object({
|
|
928
1225
|
toolName: z.string(),
|
|
929
1226
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
@@ -958,8 +1255,9 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
958
1255
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
959
1256
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
960
1257
|
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."),
|
|
961
|
-
|
|
962
|
-
|
|
1258
|
+
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."),
|
|
1259
|
+
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."),
|
|
1260
|
+
negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
963
1261
|
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
964
1262
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
965
1263
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
@@ -974,23 +1272,35 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
974
1272
|
demoRecordingUrl: z.string().optional(),
|
|
975
1273
|
serverUrl: z.string().optional(),
|
|
976
1274
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1275
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1276
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
977
1277
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
978
1278
|
});
|
|
979
|
-
|
|
1279
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1280
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
980
1281
|
appName: true,
|
|
981
1282
|
developerName: true,
|
|
982
1283
|
serverUrl: true,
|
|
983
1284
|
tools: true,
|
|
1285
|
+
skills: true,
|
|
984
1286
|
authentication: true
|
|
985
1287
|
});
|
|
986
|
-
|
|
1288
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1289
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
987
1290
|
tagline: true,
|
|
988
1291
|
description: true,
|
|
989
1292
|
category: true,
|
|
990
1293
|
testCases: true,
|
|
991
1294
|
negativeTestCases: true,
|
|
992
1295
|
toolJustifications: true
|
|
993
|
-
}).extend({
|
|
1296
|
+
}).extend({
|
|
1297
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1298
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1299
|
+
}).extend({
|
|
1300
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1301
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1302
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1303
|
+
});
|
|
994
1304
|
const claudeCategorySchema = z.enum([
|
|
995
1305
|
"Productivity",
|
|
996
1306
|
"Communication",
|
|
@@ -1113,7 +1423,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1113
1423
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1114
1424
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1115
1425
|
});
|
|
1116
|
-
|
|
1426
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1427
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1117
1428
|
serverUrl: true,
|
|
1118
1429
|
name: true,
|
|
1119
1430
|
slug: true,
|
|
@@ -1135,27 +1446,86 @@ const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
|
1135
1446
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1136
1447
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1137
1448
|
});
|
|
1138
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1449
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1139
1450
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1140
1451
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1141
1452
|
});
|
|
1453
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1454
|
+
const byField = {};
|
|
1455
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1456
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1457
|
+
return byField;
|
|
1458
|
+
}
|
|
1459
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1460
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1461
|
+
"pass",
|
|
1462
|
+
"fail",
|
|
1463
|
+
"unverified"
|
|
1464
|
+
]);
|
|
1465
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1466
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1467
|
+
claudeai: ["privacyPolicy"]
|
|
1468
|
+
};
|
|
1469
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1470
|
+
const policyDisclosureSchema = z.enum([
|
|
1471
|
+
"dataCategories",
|
|
1472
|
+
"purposesOfUse",
|
|
1473
|
+
"recipients",
|
|
1474
|
+
"retention"
|
|
1475
|
+
]);
|
|
1476
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1477
|
+
field: verifiableUrlFieldSchema,
|
|
1478
|
+
url: z.string(),
|
|
1479
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1480
|
+
reason: z.string(),
|
|
1481
|
+
concerns: z.array(z.string()).optional(),
|
|
1482
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1483
|
+
});
|
|
1484
|
+
const urlVerificationSchema = z.object({
|
|
1485
|
+
verifiedAt: z.coerce.date(),
|
|
1486
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1487
|
+
});
|
|
1488
|
+
const pageKindSchema = z.enum([
|
|
1489
|
+
"expectedDocument",
|
|
1490
|
+
"errorPage",
|
|
1491
|
+
"loginWall",
|
|
1492
|
+
"parkedDomain",
|
|
1493
|
+
"comingSoon",
|
|
1494
|
+
"marketingPage",
|
|
1495
|
+
"unrelatedDocument"
|
|
1496
|
+
]);
|
|
1497
|
+
z.object({
|
|
1498
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1499
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1500
|
+
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.")
|
|
1501
|
+
});
|
|
1142
1502
|
const submissionMetaFieldsSchema = z.object({
|
|
1143
1503
|
id: z.string(),
|
|
1144
1504
|
environmentId: z.string(),
|
|
1145
1505
|
auditId: z.string().nullable(),
|
|
1506
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1146
1507
|
createdAt: z.coerce.date(),
|
|
1147
1508
|
updatedAt: z.coerce.date()
|
|
1148
1509
|
});
|
|
1149
1510
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1150
1511
|
platform: z.literal("claudeai"),
|
|
1151
|
-
formData: claudeSubmissionDraftSchema
|
|
1512
|
+
formData: claudeSubmissionDraftSchema,
|
|
1513
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1152
1514
|
});
|
|
1153
1515
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1154
1516
|
platform: z.literal("chatgpt"),
|
|
1155
|
-
formData: chatgptSubmissionDraftSchema
|
|
1517
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1518
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1156
1519
|
});
|
|
1157
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1520
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1158
1521
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1522
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1523
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1524
|
+
z.literal([
|
|
1525
|
+
100,
|
|
1526
|
+
75,
|
|
1527
|
+
50
|
|
1528
|
+
]);
|
|
1159
1529
|
const subscriptionPlanSchema = z.enum([
|
|
1160
1530
|
"pro",
|
|
1161
1531
|
"business",
|
|
@@ -1167,17 +1537,70 @@ const customerCreditsSchema = z.object({
|
|
|
1167
1537
|
expiresAt: z.number().nullable(),
|
|
1168
1538
|
currency: z.string()
|
|
1169
1539
|
});
|
|
1170
|
-
const customerUsageSchema = z.object({
|
|
1171
|
-
amountInCents: z.number(),
|
|
1172
|
-
currency: z.string(),
|
|
1173
|
-
periodEnd: z.number()
|
|
1174
|
-
});
|
|
1175
1540
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1176
1541
|
z.object({
|
|
1177
1542
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1178
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1179
1543
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1180
1544
|
});
|
|
1545
|
+
const metricsQueueEventSchema = z.object({
|
|
1546
|
+
ts: z.number().int(),
|
|
1547
|
+
method: z.string(),
|
|
1548
|
+
tool: z.string().nullable(),
|
|
1549
|
+
client: z.string(),
|
|
1550
|
+
sessionId: z.string().nullable(),
|
|
1551
|
+
durationMs: z.number().int(),
|
|
1552
|
+
outputTokens: z.number().int().nullable(),
|
|
1553
|
+
errorType: z.enum([
|
|
1554
|
+
"mcp_error",
|
|
1555
|
+
"tool_error",
|
|
1556
|
+
"timeout"
|
|
1557
|
+
]).nullable(),
|
|
1558
|
+
errorCode: z.number().int().nullable()
|
|
1559
|
+
});
|
|
1560
|
+
z.object({
|
|
1561
|
+
v: z.literal(1),
|
|
1562
|
+
envId: z.string(),
|
|
1563
|
+
events: z.array(metricsQueueEventSchema)
|
|
1564
|
+
});
|
|
1565
|
+
z.object({ v: z.number() });
|
|
1566
|
+
const telemetrySignalSchema = z.enum([
|
|
1567
|
+
"logs",
|
|
1568
|
+
"metrics",
|
|
1569
|
+
"traces"
|
|
1570
|
+
]);
|
|
1571
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1572
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1573
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1574
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1575
|
+
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");
|
|
1576
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1577
|
+
id: z.string(),
|
|
1578
|
+
name: otlpHeaderNameSchema,
|
|
1579
|
+
value: otlpHeaderValueSchema,
|
|
1580
|
+
isSecret: z.boolean()
|
|
1581
|
+
});
|
|
1582
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1583
|
+
"credentials",
|
|
1584
|
+
"wrong-path",
|
|
1585
|
+
"wrong-protocol",
|
|
1586
|
+
"invalid-payload",
|
|
1587
|
+
"partial-rejection",
|
|
1588
|
+
"blocked-target",
|
|
1589
|
+
"timeout",
|
|
1590
|
+
"unreachable",
|
|
1591
|
+
"receiver-error",
|
|
1592
|
+
"unexpected-status"
|
|
1593
|
+
]);
|
|
1594
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1595
|
+
z.object({
|
|
1596
|
+
id: z.string(),
|
|
1597
|
+
signal: telemetrySignalSchema,
|
|
1598
|
+
endpoint: otlpEndpointSchema,
|
|
1599
|
+
protocol: otlpProtocolSchema,
|
|
1600
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1601
|
+
status: telemetryDestinationStatusSchema,
|
|
1602
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1603
|
+
});
|
|
1181
1604
|
//#endregion
|
|
1182
1605
|
//#region src/auth-scope.ts
|
|
1183
1606
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1276,6 +1699,14 @@ const serverFieldsSchema = z.object({
|
|
|
1276
1699
|
});
|
|
1277
1700
|
//#endregion
|
|
1278
1701
|
//#region src/api.contract.ts
|
|
1702
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1703
|
+
try {
|
|
1704
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1705
|
+
return true;
|
|
1706
|
+
} catch {
|
|
1707
|
+
return false;
|
|
1708
|
+
}
|
|
1709
|
+
};
|
|
1279
1710
|
const deploymentStatusSchema = z.enum([
|
|
1280
1711
|
"ongoing",
|
|
1281
1712
|
"deployed",
|
|
@@ -1304,21 +1735,20 @@ const deploymentSchema = z.object({
|
|
|
1304
1735
|
isCurrent: z.boolean(),
|
|
1305
1736
|
deploymentPageUrl: z.url().nullable()
|
|
1306
1737
|
});
|
|
1307
|
-
const
|
|
1738
|
+
const isValidTimeInput = (value) => {
|
|
1308
1739
|
if (ms(value) !== void 0) return true;
|
|
1309
1740
|
return !Number.isNaN(new Date(value).getTime());
|
|
1310
1741
|
};
|
|
1311
|
-
const
|
|
1742
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1743
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1744
|
+
const createEnvironmentContractV1 = base.route({
|
|
1312
1745
|
path: "/v1/environments",
|
|
1313
1746
|
method: "POST",
|
|
1314
1747
|
summary: "Create an environment",
|
|
1315
1748
|
description: "Create an environment for a project",
|
|
1316
1749
|
tags: ["environments"],
|
|
1317
1750
|
successDescription: "The environment has been created successfully"
|
|
1318
|
-
}).errors({
|
|
1319
|
-
NOT_FOUND: {},
|
|
1320
|
-
BAD_REQUEST: {}
|
|
1321
|
-
}).input(z.object({
|
|
1751
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1322
1752
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1323
1753
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1324
1754
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1331,7 +1761,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1331
1761
|
createdAt: z.coerce.date(),
|
|
1332
1762
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1333
1763
|
}));
|
|
1334
|
-
const getEnvironmentContractV1 =
|
|
1764
|
+
const getEnvironmentContractV1 = base.route({
|
|
1335
1765
|
path: "/v1/environments/{environmentId}",
|
|
1336
1766
|
method: "GET",
|
|
1337
1767
|
summary: "Get an environment",
|
|
@@ -1347,6 +1777,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1347
1777
|
createdAt: z.coerce.date(),
|
|
1348
1778
|
projectId: z.string()
|
|
1349
1779
|
}));
|
|
1780
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1781
|
+
path: "/v1/environments/{environmentId}",
|
|
1782
|
+
method: "DELETE",
|
|
1783
|
+
summary: "Delete an environment",
|
|
1784
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1785
|
+
tags: ["environments"],
|
|
1786
|
+
successDescription: "The environment has been deleted successfully"
|
|
1787
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1350
1788
|
const domainSchema = z.object({
|
|
1351
1789
|
domain: z.string(),
|
|
1352
1790
|
status: z.enum([
|
|
@@ -1388,7 +1826,7 @@ const projectOutputSchema = z.object({
|
|
|
1388
1826
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1389
1827
|
environments: z.array(environmentSchema)
|
|
1390
1828
|
});
|
|
1391
|
-
const getProjectContractV1 =
|
|
1829
|
+
const getProjectContractV1 = base.route({
|
|
1392
1830
|
path: "/v1/projects/{projectId}",
|
|
1393
1831
|
method: "GET",
|
|
1394
1832
|
summary: "Get a project",
|
|
@@ -1396,18 +1834,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1396
1834
|
tags: ["projects"],
|
|
1397
1835
|
successDescription: "The project details"
|
|
1398
1836
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1399
|
-
const listProjectsContractV1 =
|
|
1837
|
+
const listProjectsContractV1 = base.route({
|
|
1400
1838
|
path: "/v1/projects",
|
|
1401
1839
|
method: "GET",
|
|
1402
1840
|
summary: "List projects",
|
|
1403
1841
|
description: "List all projects for a team",
|
|
1404
1842
|
tags: ["projects"],
|
|
1405
1843
|
successDescription: "The list of projects"
|
|
1406
|
-
}).errors({
|
|
1407
|
-
|
|
1408
|
-
BAD_REQUEST: {}
|
|
1409
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1410
|
-
const createProjectContractV1 = oc.route({
|
|
1844
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1845
|
+
const createProjectContractV1 = base.route({
|
|
1411
1846
|
path: "/v1/projects",
|
|
1412
1847
|
method: "POST",
|
|
1413
1848
|
summary: "Create a project",
|
|
@@ -1416,7 +1851,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1416
1851
|
successDescription: "The project has been created successfully"
|
|
1417
1852
|
}).errors({
|
|
1418
1853
|
NOT_FOUND: {},
|
|
1419
|
-
BAD_REQUEST: {},
|
|
1420
1854
|
FORBIDDEN: {}
|
|
1421
1855
|
}).input(z.object({
|
|
1422
1856
|
teamId: z.string().optional(),
|
|
@@ -1457,7 +1891,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1457
1891
|
isSecret: z.boolean(),
|
|
1458
1892
|
createdAt: z.coerce.date()
|
|
1459
1893
|
});
|
|
1460
|
-
const listEnvironmentVariablesContractV1 =
|
|
1894
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1461
1895
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1462
1896
|
method: "GET",
|
|
1463
1897
|
summary: "List environment variables",
|
|
@@ -1465,48 +1899,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1465
1899
|
tags: ["environments"],
|
|
1466
1900
|
successDescription: "The list of environment variables"
|
|
1467
1901
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1468
|
-
const createEnvironmentVariablesContractV1 =
|
|
1902
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1469
1903
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1470
1904
|
method: "POST",
|
|
1471
1905
|
summary: "Add environment variables",
|
|
1472
1906
|
description: "Add one or more environment variables to an environment",
|
|
1473
1907
|
tags: ["environments"],
|
|
1474
1908
|
successDescription: "The environment variables have been added successfully"
|
|
1475
|
-
}).errors({
|
|
1476
|
-
NOT_FOUND: {},
|
|
1477
|
-
BAD_REQUEST: {}
|
|
1478
|
-
}).input(z.object({
|
|
1909
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1479
1910
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1480
1911
|
environmentVariables: environmentVariablesSchema
|
|
1481
1912
|
})).output(z.object({ success: z.literal(true) }));
|
|
1482
|
-
const updateEnvironmentVariableContractV1 =
|
|
1913
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1483
1914
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1484
1915
|
method: "PATCH",
|
|
1485
1916
|
summary: "Update an environment variable",
|
|
1486
1917
|
description: "Update an environment variable by ID",
|
|
1487
1918
|
tags: ["environments"],
|
|
1488
1919
|
successDescription: "The environment variable has been updated successfully"
|
|
1489
|
-
}).errors({
|
|
1490
|
-
NOT_FOUND: {},
|
|
1491
|
-
BAD_REQUEST: {}
|
|
1492
|
-
}).input(z.object({
|
|
1920
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1493
1921
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1494
1922
|
key: environmentVariableSchema.shape.key,
|
|
1495
1923
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1496
1924
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1497
1925
|
})).output(z.object({ success: z.literal(true) }));
|
|
1498
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1926
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1499
1927
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1500
1928
|
method: "DELETE",
|
|
1501
1929
|
summary: "Delete an environment variable",
|
|
1502
1930
|
description: "Delete an environment variable by ID",
|
|
1503
1931
|
tags: ["environments"],
|
|
1504
1932
|
successDescription: "The environment variable has been deleted successfully"
|
|
1505
|
-
}).errors({
|
|
1506
|
-
|
|
1507
|
-
BAD_REQUEST: {}
|
|
1508
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1509
|
-
const deleteProjectContractV1 = oc.route({
|
|
1933
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1934
|
+
const deleteProjectContractV1 = base.route({
|
|
1510
1935
|
path: "/v1/projects/{projectId}",
|
|
1511
1936
|
method: "DELETE",
|
|
1512
1937
|
summary: "Delete a project",
|
|
@@ -1514,7 +1939,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1514
1939
|
tags: ["projects"],
|
|
1515
1940
|
successDescription: "The project has been deleted successfully"
|
|
1516
1941
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1517
|
-
const updateProjectContractV1 =
|
|
1942
|
+
const updateProjectContractV1 = base.route({
|
|
1518
1943
|
path: "/v1/projects/{projectId}",
|
|
1519
1944
|
method: "PATCH",
|
|
1520
1945
|
summary: "Update a project",
|
|
@@ -1523,14 +1948,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1523
1948
|
successDescription: "The project has been updated successfully"
|
|
1524
1949
|
}).errors({
|
|
1525
1950
|
NOT_FOUND: {},
|
|
1526
|
-
BAD_REQUEST: {},
|
|
1527
1951
|
FORBIDDEN: {}
|
|
1528
1952
|
}).input(z.object({
|
|
1529
1953
|
projectId: z.string().describe("The ID of the project"),
|
|
1530
1954
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1531
1955
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1532
1956
|
})).output(projectOutputSchema);
|
|
1533
|
-
const deployEnvironmentContractV1 =
|
|
1957
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1534
1958
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1535
1959
|
method: "POST",
|
|
1536
1960
|
summary: "Deploy an environment",
|
|
@@ -1539,29 +1963,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1539
1963
|
successDescription: "The environment has been deployed successfully"
|
|
1540
1964
|
}).errors({
|
|
1541
1965
|
NOT_FOUND: {},
|
|
1542
|
-
BAD_REQUEST: {},
|
|
1543
1966
|
CONFLICT: {}
|
|
1544
1967
|
}).input(z.object({
|
|
1545
1968
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1546
1969
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1547
1970
|
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.")
|
|
1548
1971
|
})).output(deploymentSchema);
|
|
1549
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1972
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1550
1973
|
path: "/v1/deployments/upload",
|
|
1551
1974
|
method: "POST",
|
|
1552
1975
|
summary: "Upload deployment artifacts",
|
|
1553
1976
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1554
1977
|
tags: ["deployments"],
|
|
1555
1978
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1556
|
-
}).errors({
|
|
1557
|
-
NOT_FOUND: {},
|
|
1558
|
-
BAD_REQUEST: {}
|
|
1559
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1979
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1560
1980
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1561
1981
|
token: z.string().describe("Token to identify the source archive"),
|
|
1562
1982
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1563
1983
|
}));
|
|
1564
|
-
const listDeploymentsContractV1 =
|
|
1984
|
+
const listDeploymentsContractV1 = base.route({
|
|
1565
1985
|
path: "/v1/projects/{projectId}/deployments",
|
|
1566
1986
|
method: "GET",
|
|
1567
1987
|
summary: "List project deployments",
|
|
@@ -1573,7 +1993,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1573
1993
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1574
1994
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1575
1995
|
})).output(z.array(deploymentSchema));
|
|
1576
|
-
const getDeploymentContractV1 =
|
|
1996
|
+
const getDeploymentContractV1 = base.route({
|
|
1577
1997
|
path: "/v1/deployments/{deploymentId}",
|
|
1578
1998
|
method: "GET",
|
|
1579
1999
|
summary: "Get a deployment",
|
|
@@ -1596,20 +2016,17 @@ const logEntrySchema = z.object({
|
|
|
1596
2016
|
method: z.string().optional(),
|
|
1597
2017
|
durationInMs: z.number().optional()
|
|
1598
2018
|
});
|
|
1599
|
-
const getLogsContractV1 =
|
|
2019
|
+
const getLogsContractV1 = base.route({
|
|
1600
2020
|
path: "/v1/environments/{environmentId}/logs",
|
|
1601
2021
|
method: "GET",
|
|
1602
2022
|
summary: "Get logs",
|
|
1603
2023
|
description: "Get logs for an environment",
|
|
1604
2024
|
tags: ["environments"],
|
|
1605
2025
|
successDescription: "The logs"
|
|
1606
|
-
}).errors({
|
|
1607
|
-
NOT_FOUND: {},
|
|
1608
|
-
BAD_REQUEST: {}
|
|
1609
|
-
}).input(z.object({
|
|
2026
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1610
2027
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1611
|
-
since:
|
|
1612
|
-
until:
|
|
2028
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2029
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1613
2030
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1614
2031
|
level: z.array(z.enum([
|
|
1615
2032
|
"INFO",
|
|
@@ -1623,17 +2040,14 @@ const getLogsContractV1 = oc.route({
|
|
|
1623
2040
|
logs: z.array(logEntrySchema),
|
|
1624
2041
|
nextToken: z.string().nullable()
|
|
1625
2042
|
}));
|
|
1626
|
-
const getLatestLogsContractV1 =
|
|
2043
|
+
const getLatestLogsContractV1 = base.route({
|
|
1627
2044
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1628
2045
|
method: "GET",
|
|
1629
2046
|
summary: "Get latest logs",
|
|
1630
2047
|
description: "Get the N most recent logs for an environment",
|
|
1631
2048
|
tags: ["environments"],
|
|
1632
2049
|
successDescription: "The latest logs"
|
|
1633
|
-
}).errors({
|
|
1634
|
-
NOT_FOUND: {},
|
|
1635
|
-
BAD_REQUEST: {}
|
|
1636
|
-
}).input(z.object({
|
|
2050
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1637
2051
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1638
2052
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1639
2053
|
level: z.array(z.enum([
|
|
@@ -1644,7 +2058,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1644
2058
|
])).optional().describe("Filter by log level"),
|
|
1645
2059
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1646
2060
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1647
|
-
const getDeploymentLogsContractV1 =
|
|
2061
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1648
2062
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1649
2063
|
method: "GET",
|
|
1650
2064
|
summary: "Get deployment logs",
|
|
@@ -1671,22 +2085,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1671
2085
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1672
2086
|
task_count: z.array(analyticsDataPointSchema)
|
|
1673
2087
|
});
|
|
1674
|
-
const getProjectAnalyticsContractV1 =
|
|
2088
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1675
2089
|
path: "/v1/analytics/{projectId}",
|
|
1676
2090
|
method: "GET",
|
|
1677
2091
|
summary: "Get project analytics",
|
|
1678
2092
|
description: "Get analytics data for a project over a time range",
|
|
1679
2093
|
tags: ["analytics"],
|
|
1680
2094
|
successDescription: "The project analytics data"
|
|
1681
|
-
}).errors({
|
|
1682
|
-
NOT_FOUND: {},
|
|
1683
|
-
BAD_REQUEST: {}
|
|
1684
|
-
}).input(z.object({
|
|
2095
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1685
2096
|
projectId: z.string().describe("The ID of the project"),
|
|
1686
2097
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1687
2098
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1688
2099
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1689
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2100
|
+
}).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({
|
|
1690
2101
|
metadata: z.object({
|
|
1691
2102
|
startTimestamp: z.number(),
|
|
1692
2103
|
endTimestamp: z.number(),
|
|
@@ -1696,7 +2107,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1696
2107
|
}),
|
|
1697
2108
|
timeSeries: analyticsTimeSeriesSchema
|
|
1698
2109
|
}));
|
|
1699
|
-
const
|
|
2110
|
+
const paginatedInsightsInputShape = {
|
|
2111
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2112
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2113
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2114
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2115
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2116
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2117
|
+
};
|
|
2118
|
+
const listIntentsContractV1 = base.route({
|
|
2119
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2120
|
+
method: "GET",
|
|
2121
|
+
summary: "List intents",
|
|
2122
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2123
|
+
tags: ["insights"],
|
|
2124
|
+
successDescription: "The grouped user intents"
|
|
2125
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2126
|
+
...paginatedInsightsInputShape,
|
|
2127
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2128
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2129
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2130
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2131
|
+
})).output(z.object({
|
|
2132
|
+
intents: z.array(z.object({
|
|
2133
|
+
id: z.string(),
|
|
2134
|
+
intentIds: z.array(z.string()).min(1),
|
|
2135
|
+
environmentId: z.string(),
|
|
2136
|
+
message: z.string(),
|
|
2137
|
+
toolName: z.string(),
|
|
2138
|
+
createdAt: z.coerce.date(),
|
|
2139
|
+
occurrenceCount: z.number().int().positive(),
|
|
2140
|
+
clientName: z.string().nullable(),
|
|
2141
|
+
clientId: z.string().nullable(),
|
|
2142
|
+
categories: z.array(z.object({
|
|
2143
|
+
id: z.string(),
|
|
2144
|
+
name: z.string(),
|
|
2145
|
+
color: intentCategoryColorSchema
|
|
2146
|
+
}))
|
|
2147
|
+
})),
|
|
2148
|
+
totalCount: z.number().int().nonnegative()
|
|
2149
|
+
}));
|
|
2150
|
+
const listFeedbacksContractV1 = base.route({
|
|
2151
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2152
|
+
method: "GET",
|
|
2153
|
+
summary: "List feedbacks",
|
|
2154
|
+
description: "List user feedback for an environment over a time range",
|
|
2155
|
+
tags: ["insights"],
|
|
2156
|
+
successDescription: "The user feedback"
|
|
2157
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2158
|
+
...paginatedInsightsInputShape,
|
|
2159
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2160
|
+
})).output(z.object({
|
|
2161
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2162
|
+
totalCount: z.number().int().nonnegative()
|
|
2163
|
+
}));
|
|
2164
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2165
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2166
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2167
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2168
|
+
method: "GET",
|
|
2169
|
+
summary: "List intent categories",
|
|
2170
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2171
|
+
tags: ["insights"],
|
|
2172
|
+
successDescription: "The intent categories"
|
|
2173
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2174
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2175
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2176
|
+
method: "POST",
|
|
2177
|
+
summary: "Create an intent category",
|
|
2178
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2179
|
+
tags: ["insights"],
|
|
2180
|
+
successDescription: "The created intent category"
|
|
2181
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2182
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2183
|
+
name: intentCategoryNameSchema,
|
|
2184
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2185
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2186
|
+
})).output(intentCategorySchema);
|
|
2187
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2188
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2189
|
+
method: "PATCH",
|
|
2190
|
+
summary: "Update an intent category",
|
|
2191
|
+
description: "Rename or recolor an intent category",
|
|
2192
|
+
tags: ["insights"],
|
|
2193
|
+
successDescription: "The updated intent category"
|
|
2194
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2195
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2196
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2197
|
+
name: intentCategoryNameSchema.optional(),
|
|
2198
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2199
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2200
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2201
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2202
|
+
method: "DELETE",
|
|
2203
|
+
summary: "Delete an intent category",
|
|
2204
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2205
|
+
tags: ["insights"],
|
|
2206
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2207
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2208
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2209
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2210
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2211
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2212
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2213
|
+
method: "POST",
|
|
2214
|
+
summary: "Link an intent category",
|
|
2215
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2216
|
+
tags: ["insights"],
|
|
2217
|
+
successDescription: "The intents have been linked successfully"
|
|
2218
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2219
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2220
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2221
|
+
intentIds: categorizableIntentIdsSchema
|
|
2222
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2223
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2224
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2225
|
+
method: "POST",
|
|
2226
|
+
summary: "Unlink an intent category",
|
|
2227
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2228
|
+
tags: ["insights"],
|
|
2229
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2230
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2231
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2232
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2233
|
+
intentIds: categorizableIntentIdsSchema
|
|
2234
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2235
|
+
const listTeamsContractV1 = base.route({
|
|
1700
2236
|
path: "/v1/teams",
|
|
1701
2237
|
method: "GET",
|
|
1702
2238
|
summary: "List teams",
|
|
@@ -1709,7 +2245,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1709
2245
|
createdAt: z.coerce.date(),
|
|
1710
2246
|
hasStripeAccount: z.boolean()
|
|
1711
2247
|
})));
|
|
1712
|
-
const
|
|
2248
|
+
const getTeamUsageContractV1 = base.route({
|
|
2249
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2250
|
+
method: "GET",
|
|
2251
|
+
summary: "Get team usage",
|
|
2252
|
+
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.",
|
|
2253
|
+
tags: ["teams"],
|
|
2254
|
+
successDescription: "The current billing window usage"
|
|
2255
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2256
|
+
teamId: z.string(),
|
|
2257
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2258
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2259
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2260
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2261
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2262
|
+
}));
|
|
2263
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1713
2264
|
path: "/v1/tunnels/ticket",
|
|
1714
2265
|
method: "GET",
|
|
1715
2266
|
summary: "Get a tunnel ticket",
|
|
@@ -1721,16 +2272,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1721
2272
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1722
2273
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1723
2274
|
}));
|
|
1724
|
-
const publishServerContractV1 =
|
|
2275
|
+
const publishServerContractV1 = base.route({
|
|
1725
2276
|
path: "/v1/distribution/publish",
|
|
1726
2277
|
method: "POST",
|
|
1727
2278
|
summary: "Publish a server to the MCP registry",
|
|
1728
2279
|
tags: ["distribution"],
|
|
1729
2280
|
successDescription: "The server has been published successfully"
|
|
1730
|
-
}).errors({
|
|
1731
|
-
NOT_FOUND: {},
|
|
1732
|
-
BAD_REQUEST: {}
|
|
1733
|
-
}).input(z.object({
|
|
2281
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1734
2282
|
projectId: z.string(),
|
|
1735
2283
|
domain: z.string(),
|
|
1736
2284
|
title: z.string().min(1).max(100),
|
|
@@ -1739,17 +2287,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1739
2287
|
iconSrc: z.url().max(255).optional(),
|
|
1740
2288
|
dryRun: z.boolean().optional()
|
|
1741
2289
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1742
|
-
const getServerInfoContractV1 =
|
|
2290
|
+
const getServerInfoContractV1 = base.route({
|
|
1743
2291
|
path: "/v1/distribution/get",
|
|
1744
2292
|
method: "GET",
|
|
1745
2293
|
summary: "Get server info",
|
|
1746
2294
|
description: "Get info about a server",
|
|
1747
2295
|
tags: ["distribution"],
|
|
1748
2296
|
successDescription: "The server info"
|
|
1749
|
-
}).errors({
|
|
1750
|
-
NOT_FOUND: {},
|
|
1751
|
-
BAD_REQUEST: {}
|
|
1752
|
-
}).input(z.object({
|
|
2297
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1753
2298
|
projectId: z.string(),
|
|
1754
2299
|
domain: z.string()
|
|
1755
2300
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1768,7 +2313,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1768
2313
|
isPlaygroundEnabled: z.boolean(),
|
|
1769
2314
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1770
2315
|
});
|
|
1771
|
-
const getPlaygroundContractV1 =
|
|
2316
|
+
const getPlaygroundContractV1 = base.route({
|
|
1772
2317
|
path: "/v1/environments/{environmentId}/playground",
|
|
1773
2318
|
method: "GET",
|
|
1774
2319
|
summary: "Get playground configuration",
|
|
@@ -1776,17 +2321,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1776
2321
|
tags: ["environments"],
|
|
1777
2322
|
successDescription: "The playground configuration"
|
|
1778
2323
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1779
|
-
const upsertPlaygroundContractV1 =
|
|
2324
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1780
2325
|
path: "/v1/environments/{environmentId}/playground",
|
|
1781
2326
|
method: "PUT",
|
|
1782
2327
|
summary: "Update playground configuration",
|
|
1783
2328
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1784
2329
|
tags: ["environments"],
|
|
1785
2330
|
successDescription: "The updated playground configuration"
|
|
1786
|
-
}).errors({
|
|
1787
|
-
NOT_FOUND: {},
|
|
1788
|
-
BAD_REQUEST: {}
|
|
1789
|
-
}).input(z.object({
|
|
2331
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1790
2332
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1791
2333
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1792
2334
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1794,7 +2336,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1794
2336
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1795
2337
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1796
2338
|
})).output(playgroundOutputSchema);
|
|
1797
|
-
const createBeaconContractV1 =
|
|
2339
|
+
const createBeaconContractV1 = base.route({
|
|
1798
2340
|
path: "/v1/beacon/audits",
|
|
1799
2341
|
method: "POST",
|
|
1800
2342
|
summary: "Create a beacon audit",
|
|
@@ -1803,7 +2345,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1803
2345
|
successDescription: "The audit has been created"
|
|
1804
2346
|
}).errors({
|
|
1805
2347
|
NOT_FOUND: {},
|
|
1806
|
-
BAD_REQUEST: {},
|
|
1807
2348
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1808
2349
|
}).input(z.object({
|
|
1809
2350
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1811,7 +2352,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1811
2352
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1812
2353
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1813
2354
|
})).output(z.object({ id: z.string() }));
|
|
1814
|
-
const getBeaconContractV1 =
|
|
2355
|
+
const getBeaconContractV1 = base.route({
|
|
1815
2356
|
path: "/v1/beacon/audits/{auditId}",
|
|
1816
2357
|
method: "GET",
|
|
1817
2358
|
summary: "Get a beacon audit",
|
|
@@ -1826,9 +2367,73 @@ const getBeaconContractV1 = oc.route({
|
|
|
1826
2367
|
createdAt: z.coerce.date(),
|
|
1827
2368
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1828
2369
|
}));
|
|
2370
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2371
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2372
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2373
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2374
|
+
const createSubmissionContractV1 = base.route({
|
|
2375
|
+
path: "/v1/submissions",
|
|
2376
|
+
method: "POST",
|
|
2377
|
+
summary: "Create a submission package",
|
|
2378
|
+
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.",
|
|
2379
|
+
tags: ["submissions"],
|
|
2380
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2381
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2382
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2383
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2384
|
+
})).output(submissionSchema);
|
|
2385
|
+
const listSubmissionsContractV1 = base.route({
|
|
2386
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2387
|
+
method: "GET",
|
|
2388
|
+
summary: "List submission packages",
|
|
2389
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2390
|
+
tags: ["submissions"],
|
|
2391
|
+
successDescription: "The list of submission packages"
|
|
2392
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2393
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2394
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2395
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2396
|
+
})).output(z.array(submissionSchema));
|
|
2397
|
+
const getSubmissionContractV1 = base.route({
|
|
2398
|
+
path: "/v1/submissions/{submissionId}",
|
|
2399
|
+
method: "GET",
|
|
2400
|
+
summary: "Get a submission package",
|
|
2401
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2402
|
+
tags: ["submissions"],
|
|
2403
|
+
successDescription: "The submission package"
|
|
2404
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2405
|
+
const updateSubmissionContractV1 = base.route({
|
|
2406
|
+
path: "/v1/submissions/{submissionId}",
|
|
2407
|
+
method: "PUT",
|
|
2408
|
+
summary: "Update a submission package",
|
|
2409
|
+
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.",
|
|
2410
|
+
tags: ["submissions"],
|
|
2411
|
+
successDescription: "The updated submission package"
|
|
2412
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2413
|
+
submissionId: submissionIdSchema,
|
|
2414
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2415
|
+
formData: claudeSubmissionUpdateSchema
|
|
2416
|
+
}), z.object({
|
|
2417
|
+
submissionId: submissionIdSchema,
|
|
2418
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2419
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2420
|
+
})])).output(submissionSchema);
|
|
1829
2421
|
const contract = {
|
|
1830
|
-
teams: {
|
|
2422
|
+
teams: {
|
|
2423
|
+
list: { v1: listTeamsContractV1 },
|
|
2424
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2425
|
+
},
|
|
1831
2426
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2427
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2428
|
+
intentCategories: {
|
|
2429
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2430
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2431
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2432
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2433
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2434
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2435
|
+
},
|
|
2436
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1832
2437
|
deployments: {
|
|
1833
2438
|
list: { v1: listDeploymentsContractV1 },
|
|
1834
2439
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1838,6 +2443,7 @@ const contract = {
|
|
|
1838
2443
|
environments: {
|
|
1839
2444
|
create: { v1: createEnvironmentContractV1 },
|
|
1840
2445
|
get: { v1: getEnvironmentContractV1 },
|
|
2446
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1841
2447
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1842
2448
|
getLogs: { v1: getLogsContractV1 },
|
|
1843
2449
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1867,6 +2473,12 @@ const contract = {
|
|
|
1867
2473
|
beacon: {
|
|
1868
2474
|
create: { v1: createBeaconContractV1 },
|
|
1869
2475
|
get: { v1: getBeaconContractV1 }
|
|
2476
|
+
},
|
|
2477
|
+
submissions: {
|
|
2478
|
+
create: { v1: createSubmissionContractV1 },
|
|
2479
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2480
|
+
get: { v1: getSubmissionContractV1 },
|
|
2481
|
+
update: { v1: updateSubmissionContractV1 }
|
|
1870
2482
|
}
|
|
1871
2483
|
};
|
|
1872
2484
|
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
@@ -1874,5 +2486,26 @@ const contractForDocs = {
|
|
|
1874
2486
|
...contract,
|
|
1875
2487
|
deployments: deploymentsForDocs
|
|
1876
2488
|
};
|
|
2489
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2490
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2491
|
+
info: {
|
|
2492
|
+
title: "Alpic API",
|
|
2493
|
+
version: "1.0.0"
|
|
2494
|
+
},
|
|
2495
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2496
|
+
security: [{ bearerAuth: [] }],
|
|
2497
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2498
|
+
type: "http",
|
|
2499
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2500
|
+
scheme: "bearer"
|
|
2501
|
+
} } },
|
|
2502
|
+
commonSchemas: {
|
|
2503
|
+
Submission: { schema: submissionSchema },
|
|
2504
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2505
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2506
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2507
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
2508
|
+
}
|
|
2509
|
+
};
|
|
1877
2510
|
//#endregion
|
|
1878
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2511
|
+
export { AI_PLATFORMS, AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, OPENAPI_DOC_OPTIONS, PLATFORM_LABELS, buildSettingsSchema, chatgptSubmissionUpdateSchema, claudeSubmissionUpdateSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|