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