@alpic-ai/api 0.0.0-dev.gd9b541c → 0.0.0-dev.gda044d0
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 +647 -85
- package/dist/index.mjs +484 -148
- package/package.json +5 -5
package/dist/index.mjs
CHANGED
|
@@ -256,6 +256,16 @@ z.object({
|
|
|
256
256
|
clientSecret: z.string(),
|
|
257
257
|
clientScopes: z.array(z.string())
|
|
258
258
|
});
|
|
259
|
+
z.enum([
|
|
260
|
+
"opening_balance",
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"refund",
|
|
266
|
+
"admin_adjustment"
|
|
267
|
+
]);
|
|
268
|
+
z.enum(["playground"]);
|
|
259
269
|
const deploymentStatusSchema$1 = z.enum([
|
|
260
270
|
"ongoing",
|
|
261
271
|
"deployed",
|
|
@@ -283,33 +293,18 @@ const deploymentSummarySchema = z.object({
|
|
|
283
293
|
createdAt: z.coerce.date(),
|
|
284
294
|
updatedAt: z.coerce.date()
|
|
285
295
|
});
|
|
286
|
-
/**
|
|
287
|
-
* Public environment
|
|
288
|
-
*
|
|
289
|
-
* Answers anonymously and exposes no OAuth metadata.
|
|
290
|
-
*/
|
|
296
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
291
297
|
const publicEnvironmentSchema = z.object({
|
|
292
298
|
allowsAnonymous: z.literal(true),
|
|
293
299
|
oAuthMetadata: z.strictObject({})
|
|
294
300
|
});
|
|
295
|
-
/**
|
|
296
|
-
* Protected environment with an external resource metadata URL
|
|
297
|
-
*
|
|
298
|
-
* An external resource metadata URL is returned in the WWW-Authenticate header during the first 401 response.
|
|
299
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
300
|
-
*/
|
|
301
|
+
/** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
|
|
301
302
|
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
302
303
|
allowsAnonymous: z.boolean(),
|
|
303
304
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
304
305
|
scope: z.string().optional()
|
|
305
306
|
});
|
|
306
|
-
/**
|
|
307
|
-
* Protected environment with an external authorization server URL
|
|
308
|
-
*
|
|
309
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
310
|
-
* An external authorization server URL is returned when requesting the endpoint.
|
|
311
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
312
|
-
*/
|
|
307
|
+
/** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
|
|
313
308
|
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
314
309
|
allowsAnonymous: z.boolean(),
|
|
315
310
|
oAuthMetadata: z.object({
|
|
@@ -318,12 +313,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
318
313
|
}),
|
|
319
314
|
scope: z.string().optional()
|
|
320
315
|
});
|
|
321
|
-
/**
|
|
322
|
-
* Standalone protected environment
|
|
323
|
-
*
|
|
324
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
325
|
-
* The server itself exposes the /.well-known/oauth-authorization-server endpoint.
|
|
326
|
-
*/
|
|
316
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
327
317
|
const standaloneEnvironmentSchema = z.object({
|
|
328
318
|
allowsAnonymous: z.boolean(),
|
|
329
319
|
oAuthMetadata: z.object({
|
|
@@ -332,13 +322,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
332
322
|
}),
|
|
333
323
|
scope: z.string().optional()
|
|
334
324
|
});
|
|
335
|
-
/**
|
|
336
|
-
* Protected environment without OAuth discovery
|
|
337
|
-
*
|
|
338
|
-
* The server enforces authentication but exposes no OAuth discovery metadata.
|
|
339
|
-
* Neither /.well-known/oauth-protected-resource nor /.well-known/oauth-authorization-server
|
|
340
|
-
* are advertised. Clients must obtain credentials out-of-band.
|
|
341
|
-
*/
|
|
325
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
342
326
|
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
343
327
|
allowsAnonymous: z.literal(false),
|
|
344
328
|
oAuthMetadata: z.strictObject({}),
|
|
@@ -428,12 +412,13 @@ z.object({
|
|
|
428
412
|
collectUserData: z.boolean(),
|
|
429
413
|
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
430
414
|
});
|
|
431
|
-
z.object({
|
|
415
|
+
const feedbackSchema = z.object({
|
|
432
416
|
id: z.string(),
|
|
433
417
|
createdAt: z.coerce.date(),
|
|
434
418
|
environmentId: z.string(),
|
|
435
419
|
content: z.string(),
|
|
436
|
-
source: z.enum(["model", "user"])
|
|
420
|
+
source: z.enum(["model", "user"]),
|
|
421
|
+
clientName: z.string().nullable()
|
|
437
422
|
});
|
|
438
423
|
z.object({
|
|
439
424
|
content: z.string(),
|
|
@@ -449,7 +434,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
449
434
|
"pink",
|
|
450
435
|
"gray"
|
|
451
436
|
]);
|
|
452
|
-
intentCategoryColorSchema.options;
|
|
437
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
453
438
|
const intentCategorySchema = z.object({
|
|
454
439
|
id: z.string(),
|
|
455
440
|
createdAt: z.coerce.date(),
|
|
@@ -457,7 +442,7 @@ const intentCategorySchema = z.object({
|
|
|
457
442
|
name: z.string(),
|
|
458
443
|
color: intentCategoryColorSchema
|
|
459
444
|
});
|
|
460
|
-
z.object({
|
|
445
|
+
const intentCategorySummarySchema = z.object({
|
|
461
446
|
id: z.string(),
|
|
462
447
|
name: z.string(),
|
|
463
448
|
color: intentCategoryColorSchema,
|
|
@@ -469,6 +454,7 @@ z.object({
|
|
|
469
454
|
environmentId: z.string(),
|
|
470
455
|
toolName: z.string(),
|
|
471
456
|
message: z.string(),
|
|
457
|
+
clientName: z.string().nullable(),
|
|
472
458
|
categories: z.array(intentCategorySchema)
|
|
473
459
|
});
|
|
474
460
|
const signalCategorySchema = z.object({
|
|
@@ -533,6 +519,246 @@ z.enum([
|
|
|
533
519
|
"DEBUG",
|
|
534
520
|
"ERROR"
|
|
535
521
|
]);
|
|
522
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
523
|
+
const MCP_CLIENT_GROUPS = [
|
|
524
|
+
{
|
|
525
|
+
id: "claude_code",
|
|
526
|
+
label: "Claude Code",
|
|
527
|
+
vendor: "anthropic",
|
|
528
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
529
|
+
},
|
|
530
|
+
{
|
|
531
|
+
id: "claude",
|
|
532
|
+
label: "Claude",
|
|
533
|
+
vendor: "anthropic",
|
|
534
|
+
rawNames: [
|
|
535
|
+
"Anthropic/ClaudeAI",
|
|
536
|
+
"claude-ai",
|
|
537
|
+
"claude",
|
|
538
|
+
"Claude",
|
|
539
|
+
"claude-desktop",
|
|
540
|
+
"claude-desktop-3p"
|
|
541
|
+
]
|
|
542
|
+
},
|
|
543
|
+
{
|
|
544
|
+
id: "claude_mobile",
|
|
545
|
+
label: "Claude mobile",
|
|
546
|
+
vendor: "anthropic",
|
|
547
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
548
|
+
},
|
|
549
|
+
{
|
|
550
|
+
id: "claude_cowork",
|
|
551
|
+
label: "Claude Cowork",
|
|
552
|
+
vendor: "anthropic",
|
|
553
|
+
rawNames: ["Anthropic/Cowork"]
|
|
554
|
+
},
|
|
555
|
+
{
|
|
556
|
+
id: "claude_toolbox",
|
|
557
|
+
label: "Claude Toolbox",
|
|
558
|
+
vendor: "anthropic",
|
|
559
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
560
|
+
},
|
|
561
|
+
{
|
|
562
|
+
id: "anthropic_api",
|
|
563
|
+
label: "Anthropic API",
|
|
564
|
+
vendor: "anthropic",
|
|
565
|
+
rawNames: ["Anthropic/API"]
|
|
566
|
+
},
|
|
567
|
+
{
|
|
568
|
+
id: "anthropic_connector_refresh",
|
|
569
|
+
label: "Anthropic (connector refresh)",
|
|
570
|
+
vendor: "anthropic",
|
|
571
|
+
rawNames: ["Anthropic"]
|
|
572
|
+
},
|
|
573
|
+
{
|
|
574
|
+
id: "codex",
|
|
575
|
+
label: "Codex",
|
|
576
|
+
vendor: "openai",
|
|
577
|
+
rawNames: [
|
|
578
|
+
"codex-mcp-client",
|
|
579
|
+
"codex",
|
|
580
|
+
"Codex",
|
|
581
|
+
"codex-cli",
|
|
582
|
+
"openai-mcp (Codex)"
|
|
583
|
+
]
|
|
584
|
+
},
|
|
585
|
+
{
|
|
586
|
+
id: "chatgpt",
|
|
587
|
+
label: "ChatGPT",
|
|
588
|
+
vendor: "openai",
|
|
589
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
590
|
+
},
|
|
591
|
+
{
|
|
592
|
+
id: "openai_responses_api",
|
|
593
|
+
label: "OpenAI Responses API",
|
|
594
|
+
vendor: "openai",
|
|
595
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
596
|
+
},
|
|
597
|
+
{
|
|
598
|
+
id: "openai_agent_builder",
|
|
599
|
+
label: "OpenAI Agent Builder",
|
|
600
|
+
vendor: "openai",
|
|
601
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
602
|
+
},
|
|
603
|
+
{
|
|
604
|
+
id: "openai_other",
|
|
605
|
+
label: "OpenAI Other",
|
|
606
|
+
vendor: "openai",
|
|
607
|
+
rawNames: ["openai-mcp"]
|
|
608
|
+
},
|
|
609
|
+
{
|
|
610
|
+
id: "cursor",
|
|
611
|
+
label: "Cursor",
|
|
612
|
+
vendor: "cursor",
|
|
613
|
+
rawNames: [
|
|
614
|
+
"cursor-vscode",
|
|
615
|
+
"Cursor",
|
|
616
|
+
"cursor"
|
|
617
|
+
]
|
|
618
|
+
},
|
|
619
|
+
{
|
|
620
|
+
id: "cline",
|
|
621
|
+
label: "Cline",
|
|
622
|
+
vendor: "cline",
|
|
623
|
+
rawNames: [
|
|
624
|
+
"Cline",
|
|
625
|
+
"cline",
|
|
626
|
+
"@cline/core"
|
|
627
|
+
]
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
id: "github_copilot",
|
|
631
|
+
label: "GitHub Copilot",
|
|
632
|
+
vendor: "githubCopilot",
|
|
633
|
+
rawNames: [
|
|
634
|
+
"Copilot",
|
|
635
|
+
"github-copilot-developer",
|
|
636
|
+
"Copilot MCP Gateway",
|
|
637
|
+
"Xcode/copilot-xcode"
|
|
638
|
+
]
|
|
639
|
+
},
|
|
640
|
+
{
|
|
641
|
+
id: "gemini_cli",
|
|
642
|
+
label: "Gemini CLI",
|
|
643
|
+
vendor: "google",
|
|
644
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
645
|
+
},
|
|
646
|
+
{
|
|
647
|
+
id: "antigravity",
|
|
648
|
+
label: "Antigravity",
|
|
649
|
+
vendor: "google",
|
|
650
|
+
rawNames: ["antigravity-client"]
|
|
651
|
+
},
|
|
652
|
+
{
|
|
653
|
+
id: "gemini",
|
|
654
|
+
label: "Gemini",
|
|
655
|
+
vendor: "google",
|
|
656
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
657
|
+
},
|
|
658
|
+
{
|
|
659
|
+
id: "windsurf",
|
|
660
|
+
label: "Windsurf",
|
|
661
|
+
vendor: "windsurf",
|
|
662
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
663
|
+
},
|
|
664
|
+
{
|
|
665
|
+
id: "mistral",
|
|
666
|
+
label: "Mistral / Le Chat",
|
|
667
|
+
vendor: "mistral",
|
|
668
|
+
rawNames: ["Mistral"],
|
|
669
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
670
|
+
},
|
|
671
|
+
{
|
|
672
|
+
id: "n8n",
|
|
673
|
+
label: "n8n",
|
|
674
|
+
vendor: "n8n",
|
|
675
|
+
rawNames: [
|
|
676
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
677
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
678
|
+
"n8n"
|
|
679
|
+
]
|
|
680
|
+
},
|
|
681
|
+
{
|
|
682
|
+
id: "alpic_playground",
|
|
683
|
+
label: "Alpic Playground",
|
|
684
|
+
vendor: "alpic",
|
|
685
|
+
rawNames: ["alpic-playground", "playground"]
|
|
686
|
+
},
|
|
687
|
+
{
|
|
688
|
+
id: "opencode",
|
|
689
|
+
label: "opencode",
|
|
690
|
+
vendor: "opencode",
|
|
691
|
+
rawNames: ["opencode"]
|
|
692
|
+
},
|
|
693
|
+
{
|
|
694
|
+
id: "zed",
|
|
695
|
+
label: "Zed",
|
|
696
|
+
vendor: "zed",
|
|
697
|
+
rawNames: ["Zed", "zed"]
|
|
698
|
+
},
|
|
699
|
+
{
|
|
700
|
+
id: "zapier",
|
|
701
|
+
label: "Zapier",
|
|
702
|
+
vendor: "zapier",
|
|
703
|
+
rawNames: ["Zapier", "zapier"]
|
|
704
|
+
},
|
|
705
|
+
{
|
|
706
|
+
id: "make",
|
|
707
|
+
label: "Make",
|
|
708
|
+
vendor: "make",
|
|
709
|
+
rawNames: ["Make", "make"]
|
|
710
|
+
},
|
|
711
|
+
{
|
|
712
|
+
id: "librechat",
|
|
713
|
+
label: "LibreChat",
|
|
714
|
+
vendor: "mcp",
|
|
715
|
+
rawNames: ["LibreChat", "librechat"]
|
|
716
|
+
},
|
|
717
|
+
{
|
|
718
|
+
id: "jan",
|
|
719
|
+
label: "Jan",
|
|
720
|
+
vendor: "mcp",
|
|
721
|
+
rawNames: ["Jan", "jan"]
|
|
722
|
+
},
|
|
723
|
+
{
|
|
724
|
+
id: "goose",
|
|
725
|
+
label: "goose",
|
|
726
|
+
vendor: "mcp",
|
|
727
|
+
rawNames: ["goose", "Goose"]
|
|
728
|
+
},
|
|
729
|
+
{
|
|
730
|
+
id: "mcphost",
|
|
731
|
+
label: "mcphost",
|
|
732
|
+
vendor: "mcp",
|
|
733
|
+
rawNames: ["mcphost"]
|
|
734
|
+
},
|
|
735
|
+
{
|
|
736
|
+
id: "mcporter",
|
|
737
|
+
label: "mcporter",
|
|
738
|
+
vendor: "mcp",
|
|
739
|
+
rawNames: ["mcporter"]
|
|
740
|
+
},
|
|
741
|
+
{
|
|
742
|
+
id: "rmcp",
|
|
743
|
+
label: "rmcp",
|
|
744
|
+
vendor: "mcp",
|
|
745
|
+
rawNames: ["rmcp"]
|
|
746
|
+
},
|
|
747
|
+
{
|
|
748
|
+
id: "unnamed_client",
|
|
749
|
+
label: "Unnamed client",
|
|
750
|
+
vendor: "mcp",
|
|
751
|
+
rawNames: [
|
|
752
|
+
"mcp",
|
|
753
|
+
"unknown",
|
|
754
|
+
""
|
|
755
|
+
]
|
|
756
|
+
}
|
|
757
|
+
];
|
|
758
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
759
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
760
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
761
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
536
762
|
const runtimeSchema = z.enum([
|
|
537
763
|
"python3.13",
|
|
538
764
|
"python3.14",
|
|
@@ -610,15 +836,7 @@ z.object({
|
|
|
610
836
|
serverFields: serverFieldsSchema$1,
|
|
611
837
|
source: z.enum(["registry", "defaults"])
|
|
612
838
|
});
|
|
613
|
-
/**
|
|
614
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
615
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
616
|
-
*
|
|
617
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
618
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
619
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
620
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
621
|
-
*/
|
|
839
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
622
840
|
const clampStringField = (field) => {
|
|
623
841
|
const max = field.maxLength;
|
|
624
842
|
if (max === null) return field;
|
|
@@ -964,11 +1182,7 @@ const chatgptToolJustificationSchema = z.object({
|
|
|
964
1182
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
965
1183
|
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
966
1184
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
967
|
-
/**
|
|
968
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
969
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
970
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
971
|
-
*/
|
|
1185
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
972
1186
|
const chatgptTaglineSchema = z.string().max(30);
|
|
973
1187
|
const chatgptDescriptionSchema = z.string();
|
|
974
1188
|
const chatgptTranslationSchema = z.object({
|
|
@@ -977,10 +1191,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
977
1191
|
description: chatgptDescriptionSchema
|
|
978
1192
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
979
1193
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
980
|
-
/**
|
|
981
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
982
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
983
|
-
*/
|
|
1194
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
984
1195
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
985
1196
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
986
1197
|
logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
|
|
@@ -1077,11 +1288,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1077
1288
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1078
1289
|
"Public documentation for this connector will be live by the publish date."
|
|
1079
1290
|
]);
|
|
1080
|
-
/**
|
|
1081
|
-
* Field order mirrors the claude.ai directory submission wizard
|
|
1082
|
-
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1083
|
-
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1084
|
-
*/
|
|
1291
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
1085
1292
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1086
1293
|
serverUrl: z.url().describe(`The full https:// URL where your MCP server is hosted and reachable. In the claude.ai wizard this is read live
|
|
1087
1294
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1173,12 +1380,7 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1173
1380
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1174
1381
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1175
1382
|
});
|
|
1176
|
-
/**
|
|
1177
|
-
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1178
|
-
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1179
|
-
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1180
|
-
* colocated with the Claude contract.
|
|
1181
|
-
*/
|
|
1383
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1182
1384
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1183
1385
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1184
1386
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
@@ -1206,6 +1408,11 @@ const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
|
1206
1408
|
});
|
|
1207
1409
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1208
1410
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1411
|
+
z.literal([
|
|
1412
|
+
100,
|
|
1413
|
+
75,
|
|
1414
|
+
50
|
|
1415
|
+
]);
|
|
1209
1416
|
const subscriptionPlanSchema = z.enum([
|
|
1210
1417
|
"pro",
|
|
1211
1418
|
"business",
|
|
@@ -1223,11 +1430,25 @@ const customerUsageSchema = z.object({
|
|
|
1223
1430
|
periodEnd: z.number()
|
|
1224
1431
|
});
|
|
1225
1432
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1433
|
+
z.object({ balanceInNanoUSD: z.number() });
|
|
1226
1434
|
z.object({
|
|
1227
1435
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1228
1436
|
customerUsage: customerUsageSchema.nullable(),
|
|
1229
1437
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1230
1438
|
});
|
|
1439
|
+
const telemetrySignalSchema = z.enum([
|
|
1440
|
+
"logs",
|
|
1441
|
+
"metrics",
|
|
1442
|
+
"traces"
|
|
1443
|
+
]);
|
|
1444
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1445
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1446
|
+
z.object({
|
|
1447
|
+
id: z.string(),
|
|
1448
|
+
signal: telemetrySignalSchema,
|
|
1449
|
+
endpoint: otlpEndpointSchema,
|
|
1450
|
+
protocol: otlpProtocolSchema
|
|
1451
|
+
});
|
|
1231
1452
|
//#endregion
|
|
1232
1453
|
//#region src/auth-scope.ts
|
|
1233
1454
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1354,21 +1575,20 @@ const deploymentSchema = z.object({
|
|
|
1354
1575
|
isCurrent: z.boolean(),
|
|
1355
1576
|
deploymentPageUrl: z.url().nullable()
|
|
1356
1577
|
});
|
|
1357
|
-
const
|
|
1578
|
+
const isValidTimeInput = (value) => {
|
|
1358
1579
|
if (ms(value) !== void 0) return true;
|
|
1359
1580
|
return !Number.isNaN(new Date(value).getTime());
|
|
1360
1581
|
};
|
|
1361
|
-
const
|
|
1582
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1583
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1584
|
+
const createEnvironmentContractV1 = base.route({
|
|
1362
1585
|
path: "/v1/environments",
|
|
1363
1586
|
method: "POST",
|
|
1364
1587
|
summary: "Create an environment",
|
|
1365
1588
|
description: "Create an environment for a project",
|
|
1366
1589
|
tags: ["environments"],
|
|
1367
1590
|
successDescription: "The environment has been created successfully"
|
|
1368
|
-
}).errors({
|
|
1369
|
-
NOT_FOUND: {},
|
|
1370
|
-
BAD_REQUEST: {}
|
|
1371
|
-
}).input(z.object({
|
|
1591
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1372
1592
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1373
1593
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1374
1594
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1381,7 +1601,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1381
1601
|
createdAt: z.coerce.date(),
|
|
1382
1602
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1383
1603
|
}));
|
|
1384
|
-
const getEnvironmentContractV1 =
|
|
1604
|
+
const getEnvironmentContractV1 = base.route({
|
|
1385
1605
|
path: "/v1/environments/{environmentId}",
|
|
1386
1606
|
method: "GET",
|
|
1387
1607
|
summary: "Get an environment",
|
|
@@ -1438,7 +1658,7 @@ const projectOutputSchema = z.object({
|
|
|
1438
1658
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1439
1659
|
environments: z.array(environmentSchema)
|
|
1440
1660
|
});
|
|
1441
|
-
const getProjectContractV1 =
|
|
1661
|
+
const getProjectContractV1 = base.route({
|
|
1442
1662
|
path: "/v1/projects/{projectId}",
|
|
1443
1663
|
method: "GET",
|
|
1444
1664
|
summary: "Get a project",
|
|
@@ -1446,18 +1666,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1446
1666
|
tags: ["projects"],
|
|
1447
1667
|
successDescription: "The project details"
|
|
1448
1668
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1449
|
-
const listProjectsContractV1 =
|
|
1669
|
+
const listProjectsContractV1 = base.route({
|
|
1450
1670
|
path: "/v1/projects",
|
|
1451
1671
|
method: "GET",
|
|
1452
1672
|
summary: "List projects",
|
|
1453
1673
|
description: "List all projects for a team",
|
|
1454
1674
|
tags: ["projects"],
|
|
1455
1675
|
successDescription: "The list of projects"
|
|
1456
|
-
}).errors({
|
|
1457
|
-
|
|
1458
|
-
BAD_REQUEST: {}
|
|
1459
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1460
|
-
const createProjectContractV1 = oc.route({
|
|
1676
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1677
|
+
const createProjectContractV1 = base.route({
|
|
1461
1678
|
path: "/v1/projects",
|
|
1462
1679
|
method: "POST",
|
|
1463
1680
|
summary: "Create a project",
|
|
@@ -1466,7 +1683,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1466
1683
|
successDescription: "The project has been created successfully"
|
|
1467
1684
|
}).errors({
|
|
1468
1685
|
NOT_FOUND: {},
|
|
1469
|
-
BAD_REQUEST: {},
|
|
1470
1686
|
FORBIDDEN: {}
|
|
1471
1687
|
}).input(z.object({
|
|
1472
1688
|
teamId: z.string().optional(),
|
|
@@ -1507,7 +1723,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1507
1723
|
isSecret: z.boolean(),
|
|
1508
1724
|
createdAt: z.coerce.date()
|
|
1509
1725
|
});
|
|
1510
|
-
const listEnvironmentVariablesContractV1 =
|
|
1726
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1511
1727
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1512
1728
|
method: "GET",
|
|
1513
1729
|
summary: "List environment variables",
|
|
@@ -1515,48 +1731,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1515
1731
|
tags: ["environments"],
|
|
1516
1732
|
successDescription: "The list of environment variables"
|
|
1517
1733
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1518
|
-
const createEnvironmentVariablesContractV1 =
|
|
1734
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1519
1735
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1520
1736
|
method: "POST",
|
|
1521
1737
|
summary: "Add environment variables",
|
|
1522
1738
|
description: "Add one or more environment variables to an environment",
|
|
1523
1739
|
tags: ["environments"],
|
|
1524
1740
|
successDescription: "The environment variables have been added successfully"
|
|
1525
|
-
}).errors({
|
|
1526
|
-
NOT_FOUND: {},
|
|
1527
|
-
BAD_REQUEST: {}
|
|
1528
|
-
}).input(z.object({
|
|
1741
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1529
1742
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1530
1743
|
environmentVariables: environmentVariablesSchema
|
|
1531
1744
|
})).output(z.object({ success: z.literal(true) }));
|
|
1532
|
-
const updateEnvironmentVariableContractV1 =
|
|
1745
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1533
1746
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1534
1747
|
method: "PATCH",
|
|
1535
1748
|
summary: "Update an environment variable",
|
|
1536
1749
|
description: "Update an environment variable by ID",
|
|
1537
1750
|
tags: ["environments"],
|
|
1538
1751
|
successDescription: "The environment variable has been updated successfully"
|
|
1539
|
-
}).errors({
|
|
1540
|
-
NOT_FOUND: {},
|
|
1541
|
-
BAD_REQUEST: {}
|
|
1542
|
-
}).input(z.object({
|
|
1752
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1543
1753
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1544
1754
|
key: environmentVariableSchema.shape.key,
|
|
1545
1755
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1546
1756
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1547
1757
|
})).output(z.object({ success: z.literal(true) }));
|
|
1548
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1758
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1549
1759
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1550
1760
|
method: "DELETE",
|
|
1551
1761
|
summary: "Delete an environment variable",
|
|
1552
1762
|
description: "Delete an environment variable by ID",
|
|
1553
1763
|
tags: ["environments"],
|
|
1554
1764
|
successDescription: "The environment variable has been deleted successfully"
|
|
1555
|
-
}).errors({
|
|
1556
|
-
|
|
1557
|
-
BAD_REQUEST: {}
|
|
1558
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1559
|
-
const deleteProjectContractV1 = oc.route({
|
|
1765
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1766
|
+
const deleteProjectContractV1 = base.route({
|
|
1560
1767
|
path: "/v1/projects/{projectId}",
|
|
1561
1768
|
method: "DELETE",
|
|
1562
1769
|
summary: "Delete a project",
|
|
@@ -1564,7 +1771,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1564
1771
|
tags: ["projects"],
|
|
1565
1772
|
successDescription: "The project has been deleted successfully"
|
|
1566
1773
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1567
|
-
const updateProjectContractV1 =
|
|
1774
|
+
const updateProjectContractV1 = base.route({
|
|
1568
1775
|
path: "/v1/projects/{projectId}",
|
|
1569
1776
|
method: "PATCH",
|
|
1570
1777
|
summary: "Update a project",
|
|
@@ -1573,14 +1780,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1573
1780
|
successDescription: "The project has been updated successfully"
|
|
1574
1781
|
}).errors({
|
|
1575
1782
|
NOT_FOUND: {},
|
|
1576
|
-
BAD_REQUEST: {},
|
|
1577
1783
|
FORBIDDEN: {}
|
|
1578
1784
|
}).input(z.object({
|
|
1579
1785
|
projectId: z.string().describe("The ID of the project"),
|
|
1580
1786
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1581
1787
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1582
1788
|
})).output(projectOutputSchema);
|
|
1583
|
-
const deployEnvironmentContractV1 =
|
|
1789
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1584
1790
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1585
1791
|
method: "POST",
|
|
1586
1792
|
summary: "Deploy an environment",
|
|
@@ -1589,29 +1795,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1589
1795
|
successDescription: "The environment has been deployed successfully"
|
|
1590
1796
|
}).errors({
|
|
1591
1797
|
NOT_FOUND: {},
|
|
1592
|
-
BAD_REQUEST: {},
|
|
1593
1798
|
CONFLICT: {}
|
|
1594
1799
|
}).input(z.object({
|
|
1595
1800
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1596
1801
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1597
1802
|
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.")
|
|
1598
1803
|
})).output(deploymentSchema);
|
|
1599
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1804
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1600
1805
|
path: "/v1/deployments/upload",
|
|
1601
1806
|
method: "POST",
|
|
1602
1807
|
summary: "Upload deployment artifacts",
|
|
1603
1808
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1604
1809
|
tags: ["deployments"],
|
|
1605
1810
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1606
|
-
}).errors({
|
|
1607
|
-
NOT_FOUND: {},
|
|
1608
|
-
BAD_REQUEST: {}
|
|
1609
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1811
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1610
1812
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1611
1813
|
token: z.string().describe("Token to identify the source archive"),
|
|
1612
1814
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1613
1815
|
}));
|
|
1614
|
-
const listDeploymentsContractV1 =
|
|
1816
|
+
const listDeploymentsContractV1 = base.route({
|
|
1615
1817
|
path: "/v1/projects/{projectId}/deployments",
|
|
1616
1818
|
method: "GET",
|
|
1617
1819
|
summary: "List project deployments",
|
|
@@ -1623,7 +1825,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1623
1825
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1624
1826
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1625
1827
|
})).output(z.array(deploymentSchema));
|
|
1626
|
-
const getDeploymentContractV1 =
|
|
1828
|
+
const getDeploymentContractV1 = base.route({
|
|
1627
1829
|
path: "/v1/deployments/{deploymentId}",
|
|
1628
1830
|
method: "GET",
|
|
1629
1831
|
summary: "Get a deployment",
|
|
@@ -1646,20 +1848,17 @@ const logEntrySchema = z.object({
|
|
|
1646
1848
|
method: z.string().optional(),
|
|
1647
1849
|
durationInMs: z.number().optional()
|
|
1648
1850
|
});
|
|
1649
|
-
const getLogsContractV1 =
|
|
1851
|
+
const getLogsContractV1 = base.route({
|
|
1650
1852
|
path: "/v1/environments/{environmentId}/logs",
|
|
1651
1853
|
method: "GET",
|
|
1652
1854
|
summary: "Get logs",
|
|
1653
1855
|
description: "Get logs for an environment",
|
|
1654
1856
|
tags: ["environments"],
|
|
1655
1857
|
successDescription: "The logs"
|
|
1656
|
-
}).errors({
|
|
1657
|
-
NOT_FOUND: {},
|
|
1658
|
-
BAD_REQUEST: {}
|
|
1659
|
-
}).input(z.object({
|
|
1858
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1660
1859
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1661
|
-
since:
|
|
1662
|
-
until:
|
|
1860
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1861
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1663
1862
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1664
1863
|
level: z.array(z.enum([
|
|
1665
1864
|
"INFO",
|
|
@@ -1673,17 +1872,14 @@ const getLogsContractV1 = oc.route({
|
|
|
1673
1872
|
logs: z.array(logEntrySchema),
|
|
1674
1873
|
nextToken: z.string().nullable()
|
|
1675
1874
|
}));
|
|
1676
|
-
const getLatestLogsContractV1 =
|
|
1875
|
+
const getLatestLogsContractV1 = base.route({
|
|
1677
1876
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1678
1877
|
method: "GET",
|
|
1679
1878
|
summary: "Get latest logs",
|
|
1680
1879
|
description: "Get the N most recent logs for an environment",
|
|
1681
1880
|
tags: ["environments"],
|
|
1682
1881
|
successDescription: "The latest logs"
|
|
1683
|
-
}).errors({
|
|
1684
|
-
NOT_FOUND: {},
|
|
1685
|
-
BAD_REQUEST: {}
|
|
1686
|
-
}).input(z.object({
|
|
1882
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1687
1883
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1688
1884
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1689
1885
|
level: z.array(z.enum([
|
|
@@ -1694,7 +1890,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1694
1890
|
])).optional().describe("Filter by log level"),
|
|
1695
1891
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1696
1892
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1697
|
-
const getDeploymentLogsContractV1 =
|
|
1893
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1698
1894
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1699
1895
|
method: "GET",
|
|
1700
1896
|
summary: "Get deployment logs",
|
|
@@ -1721,17 +1917,14 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1721
1917
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1722
1918
|
task_count: z.array(analyticsDataPointSchema)
|
|
1723
1919
|
});
|
|
1724
|
-
const getProjectAnalyticsContractV1 =
|
|
1920
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1725
1921
|
path: "/v1/analytics/{projectId}",
|
|
1726
1922
|
method: "GET",
|
|
1727
1923
|
summary: "Get project analytics",
|
|
1728
1924
|
description: "Get analytics data for a project over a time range",
|
|
1729
1925
|
tags: ["analytics"],
|
|
1730
1926
|
successDescription: "The project analytics data"
|
|
1731
|
-
}).errors({
|
|
1732
|
-
NOT_FOUND: {},
|
|
1733
|
-
BAD_REQUEST: {}
|
|
1734
|
-
}).input(z.object({
|
|
1927
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1735
1928
|
projectId: z.string().describe("The ID of the project"),
|
|
1736
1929
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1737
1930
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
@@ -1746,7 +1939,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1746
1939
|
}),
|
|
1747
1940
|
timeSeries: analyticsTimeSeriesSchema
|
|
1748
1941
|
}));
|
|
1749
|
-
const
|
|
1942
|
+
const paginatedInsightsInputShape = {
|
|
1943
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1944
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1945
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1946
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
1947
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
1948
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
1949
|
+
};
|
|
1950
|
+
const listIntentsContractV1 = base.route({
|
|
1951
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
1952
|
+
method: "GET",
|
|
1953
|
+
summary: "List intents",
|
|
1954
|
+
description: "List grouped user intents for an environment over a time range",
|
|
1955
|
+
tags: ["insights"],
|
|
1956
|
+
successDescription: "The grouped user intents"
|
|
1957
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1958
|
+
...paginatedInsightsInputShape,
|
|
1959
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1960
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
1961
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1962
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
1963
|
+
})).output(z.object({
|
|
1964
|
+
intents: z.array(z.object({
|
|
1965
|
+
id: z.string(),
|
|
1966
|
+
intentIds: z.array(z.string()).min(1),
|
|
1967
|
+
environmentId: z.string(),
|
|
1968
|
+
message: z.string(),
|
|
1969
|
+
toolName: z.string(),
|
|
1970
|
+
createdAt: z.coerce.date(),
|
|
1971
|
+
occurrenceCount: z.number().int().positive(),
|
|
1972
|
+
clientName: z.string().nullable(),
|
|
1973
|
+
clientId: z.string().nullable(),
|
|
1974
|
+
categories: z.array(z.object({
|
|
1975
|
+
id: z.string(),
|
|
1976
|
+
name: z.string(),
|
|
1977
|
+
color: intentCategoryColorSchema
|
|
1978
|
+
}))
|
|
1979
|
+
})),
|
|
1980
|
+
totalCount: z.number().int().nonnegative()
|
|
1981
|
+
}));
|
|
1982
|
+
const listFeedbacksContractV1 = base.route({
|
|
1983
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
1984
|
+
method: "GET",
|
|
1985
|
+
summary: "List feedbacks",
|
|
1986
|
+
description: "List user feedback for an environment over a time range",
|
|
1987
|
+
tags: ["insights"],
|
|
1988
|
+
successDescription: "The user feedback"
|
|
1989
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1990
|
+
...paginatedInsightsInputShape,
|
|
1991
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
1992
|
+
})).output(z.object({
|
|
1993
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
1994
|
+
totalCount: z.number().int().nonnegative()
|
|
1995
|
+
}));
|
|
1996
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
1997
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
1998
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
1999
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2000
|
+
method: "GET",
|
|
2001
|
+
summary: "List intent categories",
|
|
2002
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2003
|
+
tags: ["insights"],
|
|
2004
|
+
successDescription: "The intent categories"
|
|
2005
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2006
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2007
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2008
|
+
method: "POST",
|
|
2009
|
+
summary: "Create an intent category",
|
|
2010
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2011
|
+
tags: ["insights"],
|
|
2012
|
+
successDescription: "The created intent category"
|
|
2013
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2014
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2015
|
+
name: intentCategoryNameSchema,
|
|
2016
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2017
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2018
|
+
})).output(intentCategorySchema);
|
|
2019
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2020
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2021
|
+
method: "PATCH",
|
|
2022
|
+
summary: "Update an intent category",
|
|
2023
|
+
description: "Rename or recolor an intent category",
|
|
2024
|
+
tags: ["insights"],
|
|
2025
|
+
successDescription: "The updated intent category"
|
|
2026
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2027
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2028
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2029
|
+
name: intentCategoryNameSchema.optional(),
|
|
2030
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2031
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2032
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2033
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2034
|
+
method: "DELETE",
|
|
2035
|
+
summary: "Delete an intent category",
|
|
2036
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2037
|
+
tags: ["insights"],
|
|
2038
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2039
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2040
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2041
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2042
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2043
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2044
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2045
|
+
method: "POST",
|
|
2046
|
+
summary: "Link an intent category",
|
|
2047
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2048
|
+
tags: ["insights"],
|
|
2049
|
+
successDescription: "The intents have been linked successfully"
|
|
2050
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2051
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2052
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2053
|
+
intentIds: categorizableIntentIdsSchema
|
|
2054
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2055
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2056
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2057
|
+
method: "POST",
|
|
2058
|
+
summary: "Unlink an intent category",
|
|
2059
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2060
|
+
tags: ["insights"],
|
|
2061
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2062
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2063
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2064
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2065
|
+
intentIds: categorizableIntentIdsSchema
|
|
2066
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2067
|
+
const listTeamsContractV1 = base.route({
|
|
1750
2068
|
path: "/v1/teams",
|
|
1751
2069
|
method: "GET",
|
|
1752
2070
|
summary: "List teams",
|
|
@@ -1759,7 +2077,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1759
2077
|
createdAt: z.coerce.date(),
|
|
1760
2078
|
hasStripeAccount: z.boolean()
|
|
1761
2079
|
})));
|
|
1762
|
-
const
|
|
2080
|
+
const getTeamUsageContractV1 = base.route({
|
|
2081
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2082
|
+
method: "GET",
|
|
2083
|
+
summary: "Get team usage",
|
|
2084
|
+
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.",
|
|
2085
|
+
tags: ["teams"],
|
|
2086
|
+
successDescription: "The current billing window usage"
|
|
2087
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2088
|
+
teamId: z.string(),
|
|
2089
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2090
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2091
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2092
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2093
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2094
|
+
}));
|
|
2095
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1763
2096
|
path: "/v1/tunnels/ticket",
|
|
1764
2097
|
method: "GET",
|
|
1765
2098
|
summary: "Get a tunnel ticket",
|
|
@@ -1771,16 +2104,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1771
2104
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1772
2105
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1773
2106
|
}));
|
|
1774
|
-
const publishServerContractV1 =
|
|
2107
|
+
const publishServerContractV1 = base.route({
|
|
1775
2108
|
path: "/v1/distribution/publish",
|
|
1776
2109
|
method: "POST",
|
|
1777
2110
|
summary: "Publish a server to the MCP registry",
|
|
1778
2111
|
tags: ["distribution"],
|
|
1779
2112
|
successDescription: "The server has been published successfully"
|
|
1780
|
-
}).errors({
|
|
1781
|
-
NOT_FOUND: {},
|
|
1782
|
-
BAD_REQUEST: {}
|
|
1783
|
-
}).input(z.object({
|
|
2113
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1784
2114
|
projectId: z.string(),
|
|
1785
2115
|
domain: z.string(),
|
|
1786
2116
|
title: z.string().min(1).max(100),
|
|
@@ -1789,17 +2119,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1789
2119
|
iconSrc: z.url().max(255).optional(),
|
|
1790
2120
|
dryRun: z.boolean().optional()
|
|
1791
2121
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1792
|
-
const getServerInfoContractV1 =
|
|
2122
|
+
const getServerInfoContractV1 = base.route({
|
|
1793
2123
|
path: "/v1/distribution/get",
|
|
1794
2124
|
method: "GET",
|
|
1795
2125
|
summary: "Get server info",
|
|
1796
2126
|
description: "Get info about a server",
|
|
1797
2127
|
tags: ["distribution"],
|
|
1798
2128
|
successDescription: "The server info"
|
|
1799
|
-
}).errors({
|
|
1800
|
-
NOT_FOUND: {},
|
|
1801
|
-
BAD_REQUEST: {}
|
|
1802
|
-
}).input(z.object({
|
|
2129
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1803
2130
|
projectId: z.string(),
|
|
1804
2131
|
domain: z.string()
|
|
1805
2132
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1818,7 +2145,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1818
2145
|
isPlaygroundEnabled: z.boolean(),
|
|
1819
2146
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1820
2147
|
});
|
|
1821
|
-
const getPlaygroundContractV1 =
|
|
2148
|
+
const getPlaygroundContractV1 = base.route({
|
|
1822
2149
|
path: "/v1/environments/{environmentId}/playground",
|
|
1823
2150
|
method: "GET",
|
|
1824
2151
|
summary: "Get playground configuration",
|
|
@@ -1826,17 +2153,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1826
2153
|
tags: ["environments"],
|
|
1827
2154
|
successDescription: "The playground configuration"
|
|
1828
2155
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1829
|
-
const upsertPlaygroundContractV1 =
|
|
2156
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1830
2157
|
path: "/v1/environments/{environmentId}/playground",
|
|
1831
2158
|
method: "PUT",
|
|
1832
2159
|
summary: "Update playground configuration",
|
|
1833
2160
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1834
2161
|
tags: ["environments"],
|
|
1835
2162
|
successDescription: "The updated playground configuration"
|
|
1836
|
-
}).errors({
|
|
1837
|
-
NOT_FOUND: {},
|
|
1838
|
-
BAD_REQUEST: {}
|
|
1839
|
-
}).input(z.object({
|
|
2163
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1840
2164
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1841
2165
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1842
2166
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1844,7 +2168,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1844
2168
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1845
2169
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1846
2170
|
})).output(playgroundOutputSchema);
|
|
1847
|
-
const createBeaconContractV1 =
|
|
2171
|
+
const createBeaconContractV1 = base.route({
|
|
1848
2172
|
path: "/v1/beacon/audits",
|
|
1849
2173
|
method: "POST",
|
|
1850
2174
|
summary: "Create a beacon audit",
|
|
@@ -1853,7 +2177,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1853
2177
|
successDescription: "The audit has been created"
|
|
1854
2178
|
}).errors({
|
|
1855
2179
|
NOT_FOUND: {},
|
|
1856
|
-
BAD_REQUEST: {},
|
|
1857
2180
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1858
2181
|
}).input(z.object({
|
|
1859
2182
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1861,7 +2184,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1861
2184
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1862
2185
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1863
2186
|
})).output(z.object({ id: z.string() }));
|
|
1864
|
-
const getBeaconContractV1 =
|
|
2187
|
+
const getBeaconContractV1 = base.route({
|
|
1865
2188
|
path: "/v1/beacon/audits/{auditId}",
|
|
1866
2189
|
method: "GET",
|
|
1867
2190
|
summary: "Get a beacon audit",
|
|
@@ -1877,8 +2200,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1877
2200
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1878
2201
|
}));
|
|
1879
2202
|
const contract = {
|
|
1880
|
-
teams: {
|
|
2203
|
+
teams: {
|
|
2204
|
+
list: { v1: listTeamsContractV1 },
|
|
2205
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2206
|
+
},
|
|
1881
2207
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2208
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2209
|
+
intentCategories: {
|
|
2210
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2211
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2212
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2213
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2214
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2215
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2216
|
+
},
|
|
2217
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1882
2218
|
deployments: {
|
|
1883
2219
|
list: { v1: listDeploymentsContractV1 },
|
|
1884
2220
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1925,4 +2261,4 @@ const contractForDocs = {
|
|
|
1925
2261
|
deployments: deploymentsForDocs
|
|
1926
2262
|
};
|
|
1927
2263
|
//#endregion
|
|
1928
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2264
|
+
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 };
|