@alpic-ai/api 0.0.0-dev.gde89265 → 0.0.0-dev.gde987ad
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 +669 -85
- package/dist/index.mjs +558 -96
- package/package.json +8 -8
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",
|
|
@@ -1156,6 +1428,11 @@ const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
|
1156
1428
|
});
|
|
1157
1429
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1158
1430
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1431
|
+
z.literal([
|
|
1432
|
+
100,
|
|
1433
|
+
75,
|
|
1434
|
+
50
|
|
1435
|
+
]);
|
|
1159
1436
|
const subscriptionPlanSchema = z.enum([
|
|
1160
1437
|
"pro",
|
|
1161
1438
|
"business",
|
|
@@ -1167,17 +1444,70 @@ const customerCreditsSchema = z.object({
|
|
|
1167
1444
|
expiresAt: z.number().nullable(),
|
|
1168
1445
|
currency: z.string()
|
|
1169
1446
|
});
|
|
1170
|
-
const customerUsageSchema = z.object({
|
|
1171
|
-
amountInCents: z.number(),
|
|
1172
|
-
currency: z.string(),
|
|
1173
|
-
periodEnd: z.number()
|
|
1174
|
-
});
|
|
1175
1447
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1176
1448
|
z.object({
|
|
1177
1449
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1178
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1179
1450
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1180
1451
|
});
|
|
1452
|
+
const metricsQueueEventSchema = z.object({
|
|
1453
|
+
ts: z.number().int(),
|
|
1454
|
+
method: z.string(),
|
|
1455
|
+
tool: z.string().nullable(),
|
|
1456
|
+
client: z.string(),
|
|
1457
|
+
sessionId: z.string().nullable(),
|
|
1458
|
+
durationMs: z.number().int(),
|
|
1459
|
+
outputTokens: z.number().int().nullable(),
|
|
1460
|
+
errorType: z.enum([
|
|
1461
|
+
"mcp_error",
|
|
1462
|
+
"tool_error",
|
|
1463
|
+
"timeout"
|
|
1464
|
+
]).nullable(),
|
|
1465
|
+
errorCode: z.number().int().nullable()
|
|
1466
|
+
});
|
|
1467
|
+
z.object({
|
|
1468
|
+
v: z.literal(1),
|
|
1469
|
+
envId: z.string(),
|
|
1470
|
+
events: z.array(metricsQueueEventSchema)
|
|
1471
|
+
});
|
|
1472
|
+
z.object({ v: z.number() });
|
|
1473
|
+
const telemetrySignalSchema = z.enum([
|
|
1474
|
+
"logs",
|
|
1475
|
+
"metrics",
|
|
1476
|
+
"traces"
|
|
1477
|
+
]);
|
|
1478
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1479
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1480
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1481
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1482
|
+
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");
|
|
1483
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1484
|
+
id: z.string(),
|
|
1485
|
+
name: otlpHeaderNameSchema,
|
|
1486
|
+
value: otlpHeaderValueSchema,
|
|
1487
|
+
isSecret: z.boolean()
|
|
1488
|
+
});
|
|
1489
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1490
|
+
"credentials",
|
|
1491
|
+
"wrong-path",
|
|
1492
|
+
"wrong-protocol",
|
|
1493
|
+
"invalid-payload",
|
|
1494
|
+
"partial-rejection",
|
|
1495
|
+
"blocked-target",
|
|
1496
|
+
"timeout",
|
|
1497
|
+
"unreachable",
|
|
1498
|
+
"receiver-error",
|
|
1499
|
+
"unexpected-status"
|
|
1500
|
+
]);
|
|
1501
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1502
|
+
z.object({
|
|
1503
|
+
id: z.string(),
|
|
1504
|
+
signal: telemetrySignalSchema,
|
|
1505
|
+
endpoint: otlpEndpointSchema,
|
|
1506
|
+
protocol: otlpProtocolSchema,
|
|
1507
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1508
|
+
status: telemetryDestinationStatusSchema,
|
|
1509
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1510
|
+
});
|
|
1181
1511
|
//#endregion
|
|
1182
1512
|
//#region src/auth-scope.ts
|
|
1183
1513
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1276,6 +1606,14 @@ const serverFieldsSchema = z.object({
|
|
|
1276
1606
|
});
|
|
1277
1607
|
//#endregion
|
|
1278
1608
|
//#region src/api.contract.ts
|
|
1609
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1610
|
+
try {
|
|
1611
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1612
|
+
return true;
|
|
1613
|
+
} catch {
|
|
1614
|
+
return false;
|
|
1615
|
+
}
|
|
1616
|
+
};
|
|
1279
1617
|
const deploymentStatusSchema = z.enum([
|
|
1280
1618
|
"ongoing",
|
|
1281
1619
|
"deployed",
|
|
@@ -1304,21 +1642,20 @@ const deploymentSchema = z.object({
|
|
|
1304
1642
|
isCurrent: z.boolean(),
|
|
1305
1643
|
deploymentPageUrl: z.url().nullable()
|
|
1306
1644
|
});
|
|
1307
|
-
const
|
|
1645
|
+
const isValidTimeInput = (value) => {
|
|
1308
1646
|
if (ms(value) !== void 0) return true;
|
|
1309
1647
|
return !Number.isNaN(new Date(value).getTime());
|
|
1310
1648
|
};
|
|
1311
|
-
const
|
|
1649
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1650
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1651
|
+
const createEnvironmentContractV1 = base.route({
|
|
1312
1652
|
path: "/v1/environments",
|
|
1313
1653
|
method: "POST",
|
|
1314
1654
|
summary: "Create an environment",
|
|
1315
1655
|
description: "Create an environment for a project",
|
|
1316
1656
|
tags: ["environments"],
|
|
1317
1657
|
successDescription: "The environment has been created successfully"
|
|
1318
|
-
}).errors({
|
|
1319
|
-
NOT_FOUND: {},
|
|
1320
|
-
BAD_REQUEST: {}
|
|
1321
|
-
}).input(z.object({
|
|
1658
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1322
1659
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1323
1660
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1324
1661
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1331,7 +1668,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1331
1668
|
createdAt: z.coerce.date(),
|
|
1332
1669
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1333
1670
|
}));
|
|
1334
|
-
const getEnvironmentContractV1 =
|
|
1671
|
+
const getEnvironmentContractV1 = base.route({
|
|
1335
1672
|
path: "/v1/environments/{environmentId}",
|
|
1336
1673
|
method: "GET",
|
|
1337
1674
|
summary: "Get an environment",
|
|
@@ -1347,6 +1684,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1347
1684
|
createdAt: z.coerce.date(),
|
|
1348
1685
|
projectId: z.string()
|
|
1349
1686
|
}));
|
|
1687
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1688
|
+
path: "/v1/environments/{environmentId}",
|
|
1689
|
+
method: "DELETE",
|
|
1690
|
+
summary: "Delete an environment",
|
|
1691
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1692
|
+
tags: ["environments"],
|
|
1693
|
+
successDescription: "The environment has been deleted successfully"
|
|
1694
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1350
1695
|
const domainSchema = z.object({
|
|
1351
1696
|
domain: z.string(),
|
|
1352
1697
|
status: z.enum([
|
|
@@ -1388,7 +1733,7 @@ const projectOutputSchema = z.object({
|
|
|
1388
1733
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1389
1734
|
environments: z.array(environmentSchema)
|
|
1390
1735
|
});
|
|
1391
|
-
const getProjectContractV1 =
|
|
1736
|
+
const getProjectContractV1 = base.route({
|
|
1392
1737
|
path: "/v1/projects/{projectId}",
|
|
1393
1738
|
method: "GET",
|
|
1394
1739
|
summary: "Get a project",
|
|
@@ -1396,18 +1741,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1396
1741
|
tags: ["projects"],
|
|
1397
1742
|
successDescription: "The project details"
|
|
1398
1743
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1399
|
-
const listProjectsContractV1 =
|
|
1744
|
+
const listProjectsContractV1 = base.route({
|
|
1400
1745
|
path: "/v1/projects",
|
|
1401
1746
|
method: "GET",
|
|
1402
1747
|
summary: "List projects",
|
|
1403
1748
|
description: "List all projects for a team",
|
|
1404
1749
|
tags: ["projects"],
|
|
1405
1750
|
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({
|
|
1751
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1752
|
+
const createProjectContractV1 = base.route({
|
|
1411
1753
|
path: "/v1/projects",
|
|
1412
1754
|
method: "POST",
|
|
1413
1755
|
summary: "Create a project",
|
|
@@ -1416,7 +1758,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1416
1758
|
successDescription: "The project has been created successfully"
|
|
1417
1759
|
}).errors({
|
|
1418
1760
|
NOT_FOUND: {},
|
|
1419
|
-
BAD_REQUEST: {},
|
|
1420
1761
|
FORBIDDEN: {}
|
|
1421
1762
|
}).input(z.object({
|
|
1422
1763
|
teamId: z.string().optional(),
|
|
@@ -1457,7 +1798,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1457
1798
|
isSecret: z.boolean(),
|
|
1458
1799
|
createdAt: z.coerce.date()
|
|
1459
1800
|
});
|
|
1460
|
-
const listEnvironmentVariablesContractV1 =
|
|
1801
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1461
1802
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1462
1803
|
method: "GET",
|
|
1463
1804
|
summary: "List environment variables",
|
|
@@ -1465,48 +1806,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1465
1806
|
tags: ["environments"],
|
|
1466
1807
|
successDescription: "The list of environment variables"
|
|
1467
1808
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1468
|
-
const createEnvironmentVariablesContractV1 =
|
|
1809
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1469
1810
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1470
1811
|
method: "POST",
|
|
1471
1812
|
summary: "Add environment variables",
|
|
1472
1813
|
description: "Add one or more environment variables to an environment",
|
|
1473
1814
|
tags: ["environments"],
|
|
1474
1815
|
successDescription: "The environment variables have been added successfully"
|
|
1475
|
-
}).errors({
|
|
1476
|
-
NOT_FOUND: {},
|
|
1477
|
-
BAD_REQUEST: {}
|
|
1478
|
-
}).input(z.object({
|
|
1816
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1479
1817
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1480
1818
|
environmentVariables: environmentVariablesSchema
|
|
1481
1819
|
})).output(z.object({ success: z.literal(true) }));
|
|
1482
|
-
const updateEnvironmentVariableContractV1 =
|
|
1820
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1483
1821
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1484
1822
|
method: "PATCH",
|
|
1485
1823
|
summary: "Update an environment variable",
|
|
1486
1824
|
description: "Update an environment variable by ID",
|
|
1487
1825
|
tags: ["environments"],
|
|
1488
1826
|
successDescription: "The environment variable has been updated successfully"
|
|
1489
|
-
}).errors({
|
|
1490
|
-
NOT_FOUND: {},
|
|
1491
|
-
BAD_REQUEST: {}
|
|
1492
|
-
}).input(z.object({
|
|
1827
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1493
1828
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1494
1829
|
key: environmentVariableSchema.shape.key,
|
|
1495
1830
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1496
1831
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1497
1832
|
})).output(z.object({ success: z.literal(true) }));
|
|
1498
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1833
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1499
1834
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1500
1835
|
method: "DELETE",
|
|
1501
1836
|
summary: "Delete an environment variable",
|
|
1502
1837
|
description: "Delete an environment variable by ID",
|
|
1503
1838
|
tags: ["environments"],
|
|
1504
1839
|
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({
|
|
1840
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1841
|
+
const deleteProjectContractV1 = base.route({
|
|
1510
1842
|
path: "/v1/projects/{projectId}",
|
|
1511
1843
|
method: "DELETE",
|
|
1512
1844
|
summary: "Delete a project",
|
|
@@ -1514,7 +1846,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1514
1846
|
tags: ["projects"],
|
|
1515
1847
|
successDescription: "The project has been deleted successfully"
|
|
1516
1848
|
}).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 =
|
|
1849
|
+
const updateProjectContractV1 = base.route({
|
|
1518
1850
|
path: "/v1/projects/{projectId}",
|
|
1519
1851
|
method: "PATCH",
|
|
1520
1852
|
summary: "Update a project",
|
|
@@ -1523,14 +1855,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1523
1855
|
successDescription: "The project has been updated successfully"
|
|
1524
1856
|
}).errors({
|
|
1525
1857
|
NOT_FOUND: {},
|
|
1526
|
-
BAD_REQUEST: {},
|
|
1527
1858
|
FORBIDDEN: {}
|
|
1528
1859
|
}).input(z.object({
|
|
1529
1860
|
projectId: z.string().describe("The ID of the project"),
|
|
1530
1861
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1531
1862
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1532
1863
|
})).output(projectOutputSchema);
|
|
1533
|
-
const deployEnvironmentContractV1 =
|
|
1864
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1534
1865
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1535
1866
|
method: "POST",
|
|
1536
1867
|
summary: "Deploy an environment",
|
|
@@ -1539,29 +1870,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1539
1870
|
successDescription: "The environment has been deployed successfully"
|
|
1540
1871
|
}).errors({
|
|
1541
1872
|
NOT_FOUND: {},
|
|
1542
|
-
BAD_REQUEST: {},
|
|
1543
1873
|
CONFLICT: {}
|
|
1544
1874
|
}).input(z.object({
|
|
1545
1875
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1546
1876
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1547
1877
|
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
1878
|
})).output(deploymentSchema);
|
|
1549
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1879
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1550
1880
|
path: "/v1/deployments/upload",
|
|
1551
1881
|
method: "POST",
|
|
1552
1882
|
summary: "Upload deployment artifacts",
|
|
1553
1883
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1554
1884
|
tags: ["deployments"],
|
|
1555
1885
|
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({
|
|
1886
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1560
1887
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1561
1888
|
token: z.string().describe("Token to identify the source archive"),
|
|
1562
1889
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1563
1890
|
}));
|
|
1564
|
-
const listDeploymentsContractV1 =
|
|
1891
|
+
const listDeploymentsContractV1 = base.route({
|
|
1565
1892
|
path: "/v1/projects/{projectId}/deployments",
|
|
1566
1893
|
method: "GET",
|
|
1567
1894
|
summary: "List project deployments",
|
|
@@ -1573,7 +1900,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1573
1900
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1574
1901
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1575
1902
|
})).output(z.array(deploymentSchema));
|
|
1576
|
-
const getDeploymentContractV1 =
|
|
1903
|
+
const getDeploymentContractV1 = base.route({
|
|
1577
1904
|
path: "/v1/deployments/{deploymentId}",
|
|
1578
1905
|
method: "GET",
|
|
1579
1906
|
summary: "Get a deployment",
|
|
@@ -1596,20 +1923,17 @@ const logEntrySchema = z.object({
|
|
|
1596
1923
|
method: z.string().optional(),
|
|
1597
1924
|
durationInMs: z.number().optional()
|
|
1598
1925
|
});
|
|
1599
|
-
const getLogsContractV1 =
|
|
1926
|
+
const getLogsContractV1 = base.route({
|
|
1600
1927
|
path: "/v1/environments/{environmentId}/logs",
|
|
1601
1928
|
method: "GET",
|
|
1602
1929
|
summary: "Get logs",
|
|
1603
1930
|
description: "Get logs for an environment",
|
|
1604
1931
|
tags: ["environments"],
|
|
1605
1932
|
successDescription: "The logs"
|
|
1606
|
-
}).errors({
|
|
1607
|
-
NOT_FOUND: {},
|
|
1608
|
-
BAD_REQUEST: {}
|
|
1609
|
-
}).input(z.object({
|
|
1933
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1610
1934
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1611
|
-
since:
|
|
1612
|
-
until:
|
|
1935
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1936
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1613
1937
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1614
1938
|
level: z.array(z.enum([
|
|
1615
1939
|
"INFO",
|
|
@@ -1623,17 +1947,14 @@ const getLogsContractV1 = oc.route({
|
|
|
1623
1947
|
logs: z.array(logEntrySchema),
|
|
1624
1948
|
nextToken: z.string().nullable()
|
|
1625
1949
|
}));
|
|
1626
|
-
const getLatestLogsContractV1 =
|
|
1950
|
+
const getLatestLogsContractV1 = base.route({
|
|
1627
1951
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1628
1952
|
method: "GET",
|
|
1629
1953
|
summary: "Get latest logs",
|
|
1630
1954
|
description: "Get the N most recent logs for an environment",
|
|
1631
1955
|
tags: ["environments"],
|
|
1632
1956
|
successDescription: "The latest logs"
|
|
1633
|
-
}).errors({
|
|
1634
|
-
NOT_FOUND: {},
|
|
1635
|
-
BAD_REQUEST: {}
|
|
1636
|
-
}).input(z.object({
|
|
1957
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1637
1958
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1638
1959
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1639
1960
|
level: z.array(z.enum([
|
|
@@ -1644,7 +1965,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1644
1965
|
])).optional().describe("Filter by log level"),
|
|
1645
1966
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1646
1967
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1647
|
-
const getDeploymentLogsContractV1 =
|
|
1968
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1648
1969
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1649
1970
|
method: "GET",
|
|
1650
1971
|
summary: "Get deployment logs",
|
|
@@ -1671,22 +1992,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1671
1992
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1672
1993
|
task_count: z.array(analyticsDataPointSchema)
|
|
1673
1994
|
});
|
|
1674
|
-
const getProjectAnalyticsContractV1 =
|
|
1995
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1675
1996
|
path: "/v1/analytics/{projectId}",
|
|
1676
1997
|
method: "GET",
|
|
1677
1998
|
summary: "Get project analytics",
|
|
1678
1999
|
description: "Get analytics data for a project over a time range",
|
|
1679
2000
|
tags: ["analytics"],
|
|
1680
2001
|
successDescription: "The project analytics data"
|
|
1681
|
-
}).errors({
|
|
1682
|
-
NOT_FOUND: {},
|
|
1683
|
-
BAD_REQUEST: {}
|
|
1684
|
-
}).input(z.object({
|
|
2002
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1685
2003
|
projectId: z.string().describe("The ID of the project"),
|
|
1686
2004
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1687
2005
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1688
2006
|
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 <=
|
|
2007
|
+
}).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
2008
|
metadata: z.object({
|
|
1691
2009
|
startTimestamp: z.number(),
|
|
1692
2010
|
endTimestamp: z.number(),
|
|
@@ -1696,7 +2014,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1696
2014
|
}),
|
|
1697
2015
|
timeSeries: analyticsTimeSeriesSchema
|
|
1698
2016
|
}));
|
|
1699
|
-
const
|
|
2017
|
+
const paginatedInsightsInputShape = {
|
|
2018
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2019
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2020
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2021
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2022
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2023
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2024
|
+
};
|
|
2025
|
+
const listIntentsContractV1 = base.route({
|
|
2026
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2027
|
+
method: "GET",
|
|
2028
|
+
summary: "List intents",
|
|
2029
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2030
|
+
tags: ["insights"],
|
|
2031
|
+
successDescription: "The grouped user intents"
|
|
2032
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2033
|
+
...paginatedInsightsInputShape,
|
|
2034
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2035
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2036
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2037
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2038
|
+
})).output(z.object({
|
|
2039
|
+
intents: z.array(z.object({
|
|
2040
|
+
id: z.string(),
|
|
2041
|
+
intentIds: z.array(z.string()).min(1),
|
|
2042
|
+
environmentId: z.string(),
|
|
2043
|
+
message: z.string(),
|
|
2044
|
+
toolName: z.string(),
|
|
2045
|
+
createdAt: z.coerce.date(),
|
|
2046
|
+
occurrenceCount: z.number().int().positive(),
|
|
2047
|
+
clientName: z.string().nullable(),
|
|
2048
|
+
clientId: z.string().nullable(),
|
|
2049
|
+
categories: z.array(z.object({
|
|
2050
|
+
id: z.string(),
|
|
2051
|
+
name: z.string(),
|
|
2052
|
+
color: intentCategoryColorSchema
|
|
2053
|
+
}))
|
|
2054
|
+
})),
|
|
2055
|
+
totalCount: z.number().int().nonnegative()
|
|
2056
|
+
}));
|
|
2057
|
+
const listFeedbacksContractV1 = base.route({
|
|
2058
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2059
|
+
method: "GET",
|
|
2060
|
+
summary: "List feedbacks",
|
|
2061
|
+
description: "List user feedback for an environment over a time range",
|
|
2062
|
+
tags: ["insights"],
|
|
2063
|
+
successDescription: "The user feedback"
|
|
2064
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2065
|
+
...paginatedInsightsInputShape,
|
|
2066
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2067
|
+
})).output(z.object({
|
|
2068
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2069
|
+
totalCount: z.number().int().nonnegative()
|
|
2070
|
+
}));
|
|
2071
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2072
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2073
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2074
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2075
|
+
method: "GET",
|
|
2076
|
+
summary: "List intent categories",
|
|
2077
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2078
|
+
tags: ["insights"],
|
|
2079
|
+
successDescription: "The intent categories"
|
|
2080
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2081
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2082
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2083
|
+
method: "POST",
|
|
2084
|
+
summary: "Create an intent category",
|
|
2085
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2086
|
+
tags: ["insights"],
|
|
2087
|
+
successDescription: "The created intent category"
|
|
2088
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2089
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2090
|
+
name: intentCategoryNameSchema,
|
|
2091
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2092
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2093
|
+
})).output(intentCategorySchema);
|
|
2094
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2095
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2096
|
+
method: "PATCH",
|
|
2097
|
+
summary: "Update an intent category",
|
|
2098
|
+
description: "Rename or recolor an intent category",
|
|
2099
|
+
tags: ["insights"],
|
|
2100
|
+
successDescription: "The updated intent category"
|
|
2101
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2102
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2103
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2104
|
+
name: intentCategoryNameSchema.optional(),
|
|
2105
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2106
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2107
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2108
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2109
|
+
method: "DELETE",
|
|
2110
|
+
summary: "Delete an intent category",
|
|
2111
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2112
|
+
tags: ["insights"],
|
|
2113
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2114
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2115
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2116
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2117
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2118
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2119
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2120
|
+
method: "POST",
|
|
2121
|
+
summary: "Link an intent category",
|
|
2122
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2123
|
+
tags: ["insights"],
|
|
2124
|
+
successDescription: "The intents have been linked successfully"
|
|
2125
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2126
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2127
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2128
|
+
intentIds: categorizableIntentIdsSchema
|
|
2129
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2130
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2131
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2132
|
+
method: "POST",
|
|
2133
|
+
summary: "Unlink an intent category",
|
|
2134
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2135
|
+
tags: ["insights"],
|
|
2136
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2137
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2138
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2139
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2140
|
+
intentIds: categorizableIntentIdsSchema
|
|
2141
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2142
|
+
const listTeamsContractV1 = base.route({
|
|
1700
2143
|
path: "/v1/teams",
|
|
1701
2144
|
method: "GET",
|
|
1702
2145
|
summary: "List teams",
|
|
@@ -1709,7 +2152,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1709
2152
|
createdAt: z.coerce.date(),
|
|
1710
2153
|
hasStripeAccount: z.boolean()
|
|
1711
2154
|
})));
|
|
1712
|
-
const
|
|
2155
|
+
const getTeamUsageContractV1 = base.route({
|
|
2156
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2157
|
+
method: "GET",
|
|
2158
|
+
summary: "Get team usage",
|
|
2159
|
+
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.",
|
|
2160
|
+
tags: ["teams"],
|
|
2161
|
+
successDescription: "The current billing window usage"
|
|
2162
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2163
|
+
teamId: z.string(),
|
|
2164
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2165
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2166
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2167
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2168
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2169
|
+
}));
|
|
2170
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1713
2171
|
path: "/v1/tunnels/ticket",
|
|
1714
2172
|
method: "GET",
|
|
1715
2173
|
summary: "Get a tunnel ticket",
|
|
@@ -1721,16 +2179,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1721
2179
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1722
2180
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1723
2181
|
}));
|
|
1724
|
-
const publishServerContractV1 =
|
|
2182
|
+
const publishServerContractV1 = base.route({
|
|
1725
2183
|
path: "/v1/distribution/publish",
|
|
1726
2184
|
method: "POST",
|
|
1727
2185
|
summary: "Publish a server to the MCP registry",
|
|
1728
2186
|
tags: ["distribution"],
|
|
1729
2187
|
successDescription: "The server has been published successfully"
|
|
1730
|
-
}).errors({
|
|
1731
|
-
NOT_FOUND: {},
|
|
1732
|
-
BAD_REQUEST: {}
|
|
1733
|
-
}).input(z.object({
|
|
2188
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1734
2189
|
projectId: z.string(),
|
|
1735
2190
|
domain: z.string(),
|
|
1736
2191
|
title: z.string().min(1).max(100),
|
|
@@ -1739,17 +2194,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1739
2194
|
iconSrc: z.url().max(255).optional(),
|
|
1740
2195
|
dryRun: z.boolean().optional()
|
|
1741
2196
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1742
|
-
const getServerInfoContractV1 =
|
|
2197
|
+
const getServerInfoContractV1 = base.route({
|
|
1743
2198
|
path: "/v1/distribution/get",
|
|
1744
2199
|
method: "GET",
|
|
1745
2200
|
summary: "Get server info",
|
|
1746
2201
|
description: "Get info about a server",
|
|
1747
2202
|
tags: ["distribution"],
|
|
1748
2203
|
successDescription: "The server info"
|
|
1749
|
-
}).errors({
|
|
1750
|
-
NOT_FOUND: {},
|
|
1751
|
-
BAD_REQUEST: {}
|
|
1752
|
-
}).input(z.object({
|
|
2204
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1753
2205
|
projectId: z.string(),
|
|
1754
2206
|
domain: z.string()
|
|
1755
2207
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1768,7 +2220,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1768
2220
|
isPlaygroundEnabled: z.boolean(),
|
|
1769
2221
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1770
2222
|
});
|
|
1771
|
-
const getPlaygroundContractV1 =
|
|
2223
|
+
const getPlaygroundContractV1 = base.route({
|
|
1772
2224
|
path: "/v1/environments/{environmentId}/playground",
|
|
1773
2225
|
method: "GET",
|
|
1774
2226
|
summary: "Get playground configuration",
|
|
@@ -1776,17 +2228,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1776
2228
|
tags: ["environments"],
|
|
1777
2229
|
successDescription: "The playground configuration"
|
|
1778
2230
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1779
|
-
const upsertPlaygroundContractV1 =
|
|
2231
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1780
2232
|
path: "/v1/environments/{environmentId}/playground",
|
|
1781
2233
|
method: "PUT",
|
|
1782
2234
|
summary: "Update playground configuration",
|
|
1783
2235
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1784
2236
|
tags: ["environments"],
|
|
1785
2237
|
successDescription: "The updated playground configuration"
|
|
1786
|
-
}).errors({
|
|
1787
|
-
NOT_FOUND: {},
|
|
1788
|
-
BAD_REQUEST: {}
|
|
1789
|
-
}).input(z.object({
|
|
2238
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1790
2239
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1791
2240
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1792
2241
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1794,7 +2243,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1794
2243
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1795
2244
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1796
2245
|
})).output(playgroundOutputSchema);
|
|
1797
|
-
const createBeaconContractV1 =
|
|
2246
|
+
const createBeaconContractV1 = base.route({
|
|
1798
2247
|
path: "/v1/beacon/audits",
|
|
1799
2248
|
method: "POST",
|
|
1800
2249
|
summary: "Create a beacon audit",
|
|
@@ -1803,7 +2252,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1803
2252
|
successDescription: "The audit has been created"
|
|
1804
2253
|
}).errors({
|
|
1805
2254
|
NOT_FOUND: {},
|
|
1806
|
-
BAD_REQUEST: {},
|
|
1807
2255
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1808
2256
|
}).input(z.object({
|
|
1809
2257
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1811,7 +2259,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1811
2259
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1812
2260
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1813
2261
|
})).output(z.object({ id: z.string() }));
|
|
1814
|
-
const getBeaconContractV1 =
|
|
2262
|
+
const getBeaconContractV1 = base.route({
|
|
1815
2263
|
path: "/v1/beacon/audits/{auditId}",
|
|
1816
2264
|
method: "GET",
|
|
1817
2265
|
summary: "Get a beacon audit",
|
|
@@ -1827,8 +2275,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1827
2275
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1828
2276
|
}));
|
|
1829
2277
|
const contract = {
|
|
1830
|
-
teams: {
|
|
2278
|
+
teams: {
|
|
2279
|
+
list: { v1: listTeamsContractV1 },
|
|
2280
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2281
|
+
},
|
|
1831
2282
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2283
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2284
|
+
intentCategories: {
|
|
2285
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2286
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2287
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2288
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2289
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2290
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2291
|
+
},
|
|
2292
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1832
2293
|
deployments: {
|
|
1833
2294
|
list: { v1: listDeploymentsContractV1 },
|
|
1834
2295
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1838,6 +2299,7 @@ const contract = {
|
|
|
1838
2299
|
environments: {
|
|
1839
2300
|
create: { v1: createEnvironmentContractV1 },
|
|
1840
2301
|
get: { v1: getEnvironmentContractV1 },
|
|
2302
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1841
2303
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1842
2304
|
getLogs: { v1: getLogsContractV1 },
|
|
1843
2305
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1875,4 +2337,4 @@ const contractForDocs = {
|
|
|
1875
2337
|
deployments: deploymentsForDocs
|
|
1876
2338
|
};
|
|
1877
2339
|
//#endregion
|
|
1878
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2340
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|