@alpic-ai/api 0.0.0-dev.gfc8e798 → 0.0.0-dev.gfd01266
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +5433 -145
- package/dist/index.mjs +780 -172
- package/package.json +9 -9
package/dist/index.mjs
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
import * as z$1 from "zod/v4";
|
|
3
3
|
import { oc } from "@orpc/contract";
|
|
4
4
|
import ms from "ms";
|
|
5
|
-
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.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",
|
|
@@ -283,33 +303,18 @@ const deploymentSummarySchema = z.object({
|
|
|
283
303
|
createdAt: z.coerce.date(),
|
|
284
304
|
updatedAt: z.coerce.date()
|
|
285
305
|
});
|
|
286
|
-
/**
|
|
287
|
-
* Public environment
|
|
288
|
-
*
|
|
289
|
-
* Answers anonymously and exposes no OAuth metadata.
|
|
290
|
-
*/
|
|
306
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
291
307
|
const publicEnvironmentSchema = z.object({
|
|
292
308
|
allowsAnonymous: z.literal(true),
|
|
293
309
|
oAuthMetadata: z.strictObject({})
|
|
294
310
|
});
|
|
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
|
-
*/
|
|
311
|
+
/** 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
312
|
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
302
313
|
allowsAnonymous: z.boolean(),
|
|
303
314
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
304
315
|
scope: z.string().optional()
|
|
305
316
|
});
|
|
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
|
-
*/
|
|
317
|
+
/** 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
318
|
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
314
319
|
allowsAnonymous: z.boolean(),
|
|
315
320
|
oAuthMetadata: z.object({
|
|
@@ -318,12 +323,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
318
323
|
}),
|
|
319
324
|
scope: z.string().optional()
|
|
320
325
|
});
|
|
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
|
-
*/
|
|
326
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
327
327
|
const standaloneEnvironmentSchema = z.object({
|
|
328
328
|
allowsAnonymous: z.boolean(),
|
|
329
329
|
oAuthMetadata: z.object({
|
|
@@ -332,13 +332,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
332
332
|
}),
|
|
333
333
|
scope: z.string().optional()
|
|
334
334
|
});
|
|
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
|
-
*/
|
|
335
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
342
336
|
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
343
337
|
allowsAnonymous: z.literal(false),
|
|
344
338
|
oAuthMetadata: z.strictObject({}),
|
|
@@ -428,12 +422,13 @@ z.object({
|
|
|
428
422
|
collectUserData: z.boolean(),
|
|
429
423
|
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
430
424
|
});
|
|
431
|
-
z.object({
|
|
425
|
+
const feedbackSchema = z.object({
|
|
432
426
|
id: z.string(),
|
|
433
427
|
createdAt: z.coerce.date(),
|
|
434
428
|
environmentId: z.string(),
|
|
435
429
|
content: z.string(),
|
|
436
|
-
source: z.enum(["model", "user"])
|
|
430
|
+
source: z.enum(["model", "user"]),
|
|
431
|
+
clientName: z.string().nullable()
|
|
437
432
|
});
|
|
438
433
|
z.object({
|
|
439
434
|
content: z.string(),
|
|
@@ -449,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
449
444
|
"pink",
|
|
450
445
|
"gray"
|
|
451
446
|
]);
|
|
452
|
-
intentCategoryColorSchema.options;
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
453
448
|
const intentCategorySchema = z.object({
|
|
454
449
|
id: z.string(),
|
|
455
450
|
createdAt: z.coerce.date(),
|
|
@@ -457,7 +452,7 @@ const intentCategorySchema = z.object({
|
|
|
457
452
|
name: z.string(),
|
|
458
453
|
color: intentCategoryColorSchema
|
|
459
454
|
});
|
|
460
|
-
z.object({
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
461
456
|
id: z.string(),
|
|
462
457
|
name: z.string(),
|
|
463
458
|
color: intentCategoryColorSchema,
|
|
@@ -469,6 +464,7 @@ z.object({
|
|
|
469
464
|
environmentId: z.string(),
|
|
470
465
|
toolName: z.string(),
|
|
471
466
|
message: z.string(),
|
|
467
|
+
clientName: z.string().nullable(),
|
|
472
468
|
categories: z.array(intentCategorySchema)
|
|
473
469
|
});
|
|
474
470
|
const signalCategorySchema = z.object({
|
|
@@ -527,12 +523,262 @@ z.object({
|
|
|
527
523
|
createdAt: z.coerce.date(),
|
|
528
524
|
updatedAt: z.coerce.date()
|
|
529
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]);
|
|
530
536
|
z.enum([
|
|
531
537
|
"INFO",
|
|
532
538
|
"WARNING",
|
|
533
539
|
"DEBUG",
|
|
534
540
|
"ERROR"
|
|
535
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]));
|
|
536
782
|
const runtimeSchema = z.enum([
|
|
537
783
|
"python3.13",
|
|
538
784
|
"python3.14",
|
|
@@ -610,15 +856,7 @@ z.object({
|
|
|
610
856
|
serverFields: serverFieldsSchema$1,
|
|
611
857
|
source: z.enum(["registry", "defaults"])
|
|
612
858
|
});
|
|
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
|
-
*/
|
|
859
|
+
/** 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
860
|
const clampStringField = (field) => {
|
|
623
861
|
const max = field.maxLength;
|
|
624
862
|
if (max === null) return field;
|
|
@@ -626,6 +864,10 @@ const clampStringField = (field) => {
|
|
|
626
864
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
627
865
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
628
866
|
};
|
|
867
|
+
const unboundedArrayField = (field) => {
|
|
868
|
+
const unbounded = z.array(field.element);
|
|
869
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
870
|
+
};
|
|
629
871
|
const toolDefinitionSchema = z.object({
|
|
630
872
|
name: z.string(),
|
|
631
873
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -638,11 +880,22 @@ const toolDefinitionSchema = z.object({
|
|
|
638
880
|
}).optional()
|
|
639
881
|
});
|
|
640
882
|
const positiveTestCaseSchema = z.object({
|
|
641
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
642
|
-
userPrompt: z.string().describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
883
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
884
|
+
userPrompt: z.string().min(1).describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
643
885
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
644
886
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
645
|
-
}).
|
|
887
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
888
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
889
|
+
scenario: z.string().optional(),
|
|
890
|
+
userPrompt: z.string().optional()
|
|
891
|
+
});
|
|
892
|
+
const blankPositiveTestCase = () => ({
|
|
893
|
+
scenario: "",
|
|
894
|
+
userPrompt: "",
|
|
895
|
+
toolTriggered: "",
|
|
896
|
+
expectedOutput: ""
|
|
897
|
+
});
|
|
898
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
646
899
|
const screenshotEntrySchema = z.object({
|
|
647
900
|
prompt: z.string(),
|
|
648
901
|
url: z.url()
|
|
@@ -955,20 +1208,25 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
955
1208
|
"zh-TW"
|
|
956
1209
|
]);
|
|
957
1210
|
const negativeTestCaseSchema = z.object({
|
|
958
|
-
scenario: z.string(),
|
|
959
|
-
userPrompt: z.string()
|
|
960
|
-
}).
|
|
1211
|
+
scenario: z.string().min(1),
|
|
1212
|
+
userPrompt: z.string().min(1)
|
|
1213
|
+
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1214
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1215
|
+
scenario: z.string().optional(),
|
|
1216
|
+
userPrompt: z.string().optional()
|
|
1217
|
+
});
|
|
1218
|
+
const blankNegativeTestCase = () => ({
|
|
1219
|
+
scenario: "",
|
|
1220
|
+
userPrompt: ""
|
|
1221
|
+
});
|
|
1222
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
961
1223
|
const chatgptToolJustificationSchema = z.object({
|
|
962
1224
|
toolName: z.string(),
|
|
963
1225
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
964
1226
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
965
1227
|
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
1228
|
}).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
|
-
*/
|
|
1229
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
972
1230
|
const chatgptTaglineSchema = z.string().max(30);
|
|
973
1231
|
const chatgptDescriptionSchema = z.string();
|
|
974
1232
|
const chatgptTranslationSchema = z.object({
|
|
@@ -977,10 +1235,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
977
1235
|
description: chatgptDescriptionSchema
|
|
978
1236
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
979
1237
|
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
|
-
*/
|
|
1238
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
984
1239
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
985
1240
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
986
1241
|
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."),
|
|
@@ -999,8 +1254,9 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
999
1254
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
1000
1255
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1001
1256
|
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
|
|
1002
|
-
|
|
1003
|
-
|
|
1257
|
+
skills: z.array(chatgptSkillSchema).optional().describe("Skills the server exposes over MCP (auto-populated from the production server's manifest). Left unset when the server does not advertise the skills extension, which is a different state from advertising it and exposing none."),
|
|
1258
|
+
testCases: z.array(positiveTestCaseSchema).length(5).describe("Exactly 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Collectively cover the full capability across different flow stages (initial search or browse, market or locale handling, post-interaction detail, an action ChatGPT performs on the user's behalf, and a conversion or secondary tool) rather than five variations of the same first step."),
|
|
1259
|
+
negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
1004
1260
|
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
1005
1261
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1006
1262
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
@@ -1015,23 +1271,35 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
1015
1271
|
demoRecordingUrl: z.string().optional(),
|
|
1016
1272
|
serverUrl: z.string().optional(),
|
|
1017
1273
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1274
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1275
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1018
1276
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1019
1277
|
});
|
|
1020
|
-
|
|
1278
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1279
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1021
1280
|
appName: true,
|
|
1022
1281
|
developerName: true,
|
|
1023
1282
|
serverUrl: true,
|
|
1024
1283
|
tools: true,
|
|
1284
|
+
skills: true,
|
|
1025
1285
|
authentication: true
|
|
1026
1286
|
});
|
|
1027
|
-
|
|
1287
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1288
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1028
1289
|
tagline: true,
|
|
1029
1290
|
description: true,
|
|
1030
1291
|
category: true,
|
|
1031
1292
|
testCases: true,
|
|
1032
1293
|
negativeTestCases: true,
|
|
1033
1294
|
toolJustifications: true
|
|
1034
|
-
}).extend({
|
|
1295
|
+
}).extend({
|
|
1296
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1297
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1298
|
+
}).extend({
|
|
1299
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1300
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1301
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1302
|
+
});
|
|
1035
1303
|
const claudeCategorySchema = z.enum([
|
|
1036
1304
|
"Productivity",
|
|
1037
1305
|
"Communication",
|
|
@@ -1077,11 +1345,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1077
1345
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1078
1346
|
"Public documentation for this connector will be live by the publish date."
|
|
1079
1347
|
]);
|
|
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
|
-
*/
|
|
1348
|
+
/** 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
1349
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1086
1350
|
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
1351
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1158,7 +1422,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1158
1422
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1159
1423
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1160
1424
|
});
|
|
1161
|
-
|
|
1425
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1426
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1162
1427
|
serverUrl: true,
|
|
1163
1428
|
name: true,
|
|
1164
1429
|
slug: true,
|
|
@@ -1173,39 +1438,93 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1173
1438
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1174
1439
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1175
1440
|
});
|
|
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
|
-
*/
|
|
1441
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1182
1442
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1183
1443
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1184
1444
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1185
1445
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1186
1446
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1187
1447
|
});
|
|
1188
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1448
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1189
1449
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1190
1450
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1191
1451
|
});
|
|
1452
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1453
|
+
const byField = {};
|
|
1454
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1455
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1456
|
+
return byField;
|
|
1457
|
+
}
|
|
1458
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1459
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1460
|
+
"pass",
|
|
1461
|
+
"fail",
|
|
1462
|
+
"unverified"
|
|
1463
|
+
]);
|
|
1464
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1465
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1466
|
+
claudeai: ["privacyPolicy"]
|
|
1467
|
+
};
|
|
1468
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1469
|
+
const policyDisclosureSchema = z.enum([
|
|
1470
|
+
"dataCategories",
|
|
1471
|
+
"purposesOfUse",
|
|
1472
|
+
"recipients",
|
|
1473
|
+
"retention"
|
|
1474
|
+
]);
|
|
1475
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1476
|
+
field: verifiableUrlFieldSchema,
|
|
1477
|
+
url: z.string(),
|
|
1478
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1479
|
+
reason: z.string(),
|
|
1480
|
+
concerns: z.array(z.string()).optional(),
|
|
1481
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1482
|
+
});
|
|
1483
|
+
const urlVerificationSchema = z.object({
|
|
1484
|
+
verifiedAt: z.coerce.date(),
|
|
1485
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1486
|
+
});
|
|
1487
|
+
const pageKindSchema = z.enum([
|
|
1488
|
+
"expectedDocument",
|
|
1489
|
+
"errorPage",
|
|
1490
|
+
"loginWall",
|
|
1491
|
+
"parkedDomain",
|
|
1492
|
+
"comingSoon",
|
|
1493
|
+
"marketingPage",
|
|
1494
|
+
"unrelatedDocument"
|
|
1495
|
+
]);
|
|
1496
|
+
z.object({
|
|
1497
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1498
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1499
|
+
missingDisclosures: z.array(policyDisclosureSchema).describe("For a privacy policy only: which of the four required disclosures the text does not cover. Empty for every other page kind.")
|
|
1500
|
+
});
|
|
1192
1501
|
const submissionMetaFieldsSchema = z.object({
|
|
1193
1502
|
id: z.string(),
|
|
1194
1503
|
environmentId: z.string(),
|
|
1195
1504
|
auditId: z.string().nullable(),
|
|
1505
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1196
1506
|
createdAt: z.coerce.date(),
|
|
1197
1507
|
updatedAt: z.coerce.date()
|
|
1198
1508
|
});
|
|
1199
1509
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1200
1510
|
platform: z.literal("claudeai"),
|
|
1201
|
-
formData: claudeSubmissionDraftSchema
|
|
1511
|
+
formData: claudeSubmissionDraftSchema,
|
|
1512
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1202
1513
|
});
|
|
1203
1514
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1204
1515
|
platform: z.literal("chatgpt"),
|
|
1205
|
-
formData: chatgptSubmissionDraftSchema
|
|
1516
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1517
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1206
1518
|
});
|
|
1207
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1519
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1208
1520
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1521
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1522
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1523
|
+
z.literal([
|
|
1524
|
+
100,
|
|
1525
|
+
75,
|
|
1526
|
+
50
|
|
1527
|
+
]);
|
|
1209
1528
|
const subscriptionPlanSchema = z.enum([
|
|
1210
1529
|
"pro",
|
|
1211
1530
|
"business",
|
|
@@ -1217,17 +1536,96 @@ const customerCreditsSchema = z.object({
|
|
|
1217
1536
|
expiresAt: z.number().nullable(),
|
|
1218
1537
|
currency: z.string()
|
|
1219
1538
|
});
|
|
1220
|
-
const customerUsageSchema = z.object({
|
|
1221
|
-
amountInCents: z.number(),
|
|
1222
|
-
currency: z.string(),
|
|
1223
|
-
periodEnd: z.number()
|
|
1224
|
-
});
|
|
1225
1539
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1226
1540
|
z.object({
|
|
1227
1541
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1228
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1229
1542
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1230
1543
|
});
|
|
1544
|
+
const metricsQueueEventSchema = z.object({
|
|
1545
|
+
ts: z.number().int(),
|
|
1546
|
+
method: z.string(),
|
|
1547
|
+
tool: z.string().nullable(),
|
|
1548
|
+
client: z.string(),
|
|
1549
|
+
sessionId: z.string().nullable(),
|
|
1550
|
+
durationMs: z.number().int(),
|
|
1551
|
+
outputTokens: z.number().int().nullable(),
|
|
1552
|
+
errorType: z.enum([
|
|
1553
|
+
"mcp_error",
|
|
1554
|
+
"tool_error",
|
|
1555
|
+
"timeout"
|
|
1556
|
+
]).nullable(),
|
|
1557
|
+
errorCode: z.number().int().nullable()
|
|
1558
|
+
});
|
|
1559
|
+
z.object({
|
|
1560
|
+
v: z.literal(1),
|
|
1561
|
+
envId: z.string(),
|
|
1562
|
+
events: z.array(metricsQueueEventSchema)
|
|
1563
|
+
});
|
|
1564
|
+
z.object({ v: z.number() });
|
|
1565
|
+
const telemetrySignalSchema = z.enum([
|
|
1566
|
+
"logs",
|
|
1567
|
+
"metrics",
|
|
1568
|
+
"traces"
|
|
1569
|
+
]);
|
|
1570
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1571
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1572
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1573
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1574
|
+
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");
|
|
1575
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1576
|
+
id: z.string(),
|
|
1577
|
+
name: otlpHeaderNameSchema,
|
|
1578
|
+
value: otlpHeaderValueSchema,
|
|
1579
|
+
isSecret: z.boolean()
|
|
1580
|
+
});
|
|
1581
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1582
|
+
"credentials",
|
|
1583
|
+
"wrong-path",
|
|
1584
|
+
"wrong-protocol",
|
|
1585
|
+
"invalid-payload",
|
|
1586
|
+
"partial-rejection",
|
|
1587
|
+
"blocked-target",
|
|
1588
|
+
"timeout",
|
|
1589
|
+
"unreachable",
|
|
1590
|
+
"receiver-error",
|
|
1591
|
+
"unexpected-status"
|
|
1592
|
+
]);
|
|
1593
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1594
|
+
z.object({
|
|
1595
|
+
id: z.string(),
|
|
1596
|
+
signal: telemetrySignalSchema,
|
|
1597
|
+
endpoint: otlpEndpointSchema,
|
|
1598
|
+
protocol: otlpProtocolSchema,
|
|
1599
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1600
|
+
status: telemetryDestinationStatusSchema,
|
|
1601
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1602
|
+
});
|
|
1603
|
+
const webhookEventSchema = z.enum([
|
|
1604
|
+
"deployment.succeeded",
|
|
1605
|
+
"deployment.failed",
|
|
1606
|
+
"deployment.canceled"
|
|
1607
|
+
]);
|
|
1608
|
+
const webhookDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1609
|
+
const webhookDeliveryFailureReasonSchema = z.enum([
|
|
1610
|
+
"credentials",
|
|
1611
|
+
"blocked-target",
|
|
1612
|
+
"timeout",
|
|
1613
|
+
"unreachable",
|
|
1614
|
+
"receiver-error",
|
|
1615
|
+
"unexpected-status"
|
|
1616
|
+
]);
|
|
1617
|
+
const webhookUrlSchema = z.url({
|
|
1618
|
+
protocol: /^https$/,
|
|
1619
|
+
error: "Enter a valid HTTPS URL"
|
|
1620
|
+
}).max(2048, "Webhook URL must be at most 2048 characters");
|
|
1621
|
+
const webhookEventsSchema = z.array(webhookEventSchema).min(1, "Select at least one event").refine((events) => new Set(events).size === events.length, "Events must be unique");
|
|
1622
|
+
z.object({
|
|
1623
|
+
id: z.string(),
|
|
1624
|
+
url: webhookUrlSchema,
|
|
1625
|
+
events: webhookEventsSchema,
|
|
1626
|
+
status: webhookDestinationStatusSchema,
|
|
1627
|
+
lastFailureReason: webhookDeliveryFailureReasonSchema.nullable()
|
|
1628
|
+
}).extend({ secret: z.string().min(1) });
|
|
1231
1629
|
//#endregion
|
|
1232
1630
|
//#region src/auth-scope.ts
|
|
1233
1631
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1326,6 +1724,14 @@ const serverFieldsSchema = z.object({
|
|
|
1326
1724
|
});
|
|
1327
1725
|
//#endregion
|
|
1328
1726
|
//#region src/api.contract.ts
|
|
1727
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1728
|
+
try {
|
|
1729
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1730
|
+
return true;
|
|
1731
|
+
} catch {
|
|
1732
|
+
return false;
|
|
1733
|
+
}
|
|
1734
|
+
};
|
|
1329
1735
|
const deploymentStatusSchema = z.enum([
|
|
1330
1736
|
"ongoing",
|
|
1331
1737
|
"deployed",
|
|
@@ -1354,21 +1760,20 @@ const deploymentSchema = z.object({
|
|
|
1354
1760
|
isCurrent: z.boolean(),
|
|
1355
1761
|
deploymentPageUrl: z.url().nullable()
|
|
1356
1762
|
});
|
|
1357
|
-
const
|
|
1763
|
+
const isValidTimeInput = (value) => {
|
|
1358
1764
|
if (ms(value) !== void 0) return true;
|
|
1359
1765
|
return !Number.isNaN(new Date(value).getTime());
|
|
1360
1766
|
};
|
|
1361
|
-
const
|
|
1767
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1768
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1769
|
+
const createEnvironmentContractV1 = base.route({
|
|
1362
1770
|
path: "/v1/environments",
|
|
1363
1771
|
method: "POST",
|
|
1364
1772
|
summary: "Create an environment",
|
|
1365
1773
|
description: "Create an environment for a project",
|
|
1366
1774
|
tags: ["environments"],
|
|
1367
1775
|
successDescription: "The environment has been created successfully"
|
|
1368
|
-
}).errors({
|
|
1369
|
-
NOT_FOUND: {},
|
|
1370
|
-
BAD_REQUEST: {}
|
|
1371
|
-
}).input(z.object({
|
|
1776
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1372
1777
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1373
1778
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1374
1779
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1381,7 +1786,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1381
1786
|
createdAt: z.coerce.date(),
|
|
1382
1787
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1383
1788
|
}));
|
|
1384
|
-
const getEnvironmentContractV1 =
|
|
1789
|
+
const getEnvironmentContractV1 = base.route({
|
|
1385
1790
|
path: "/v1/environments/{environmentId}",
|
|
1386
1791
|
method: "GET",
|
|
1387
1792
|
summary: "Get an environment",
|
|
@@ -1397,6 +1802,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1397
1802
|
createdAt: z.coerce.date(),
|
|
1398
1803
|
projectId: z.string()
|
|
1399
1804
|
}));
|
|
1805
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1806
|
+
path: "/v1/environments/{environmentId}",
|
|
1807
|
+
method: "DELETE",
|
|
1808
|
+
summary: "Delete an environment",
|
|
1809
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1810
|
+
tags: ["environments"],
|
|
1811
|
+
successDescription: "The environment has been deleted successfully"
|
|
1812
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1400
1813
|
const domainSchema = z.object({
|
|
1401
1814
|
domain: z.string(),
|
|
1402
1815
|
status: z.enum([
|
|
@@ -1438,7 +1851,7 @@ const projectOutputSchema = z.object({
|
|
|
1438
1851
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1439
1852
|
environments: z.array(environmentSchema)
|
|
1440
1853
|
});
|
|
1441
|
-
const getProjectContractV1 =
|
|
1854
|
+
const getProjectContractV1 = base.route({
|
|
1442
1855
|
path: "/v1/projects/{projectId}",
|
|
1443
1856
|
method: "GET",
|
|
1444
1857
|
summary: "Get a project",
|
|
@@ -1446,18 +1859,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1446
1859
|
tags: ["projects"],
|
|
1447
1860
|
successDescription: "The project details"
|
|
1448
1861
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1449
|
-
const listProjectsContractV1 =
|
|
1862
|
+
const listProjectsContractV1 = base.route({
|
|
1450
1863
|
path: "/v1/projects",
|
|
1451
1864
|
method: "GET",
|
|
1452
1865
|
summary: "List projects",
|
|
1453
1866
|
description: "List all projects for a team",
|
|
1454
1867
|
tags: ["projects"],
|
|
1455
1868
|
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({
|
|
1869
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1870
|
+
const createProjectContractV1 = base.route({
|
|
1461
1871
|
path: "/v1/projects",
|
|
1462
1872
|
method: "POST",
|
|
1463
1873
|
summary: "Create a project",
|
|
@@ -1466,7 +1876,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1466
1876
|
successDescription: "The project has been created successfully"
|
|
1467
1877
|
}).errors({
|
|
1468
1878
|
NOT_FOUND: {},
|
|
1469
|
-
BAD_REQUEST: {},
|
|
1470
1879
|
FORBIDDEN: {}
|
|
1471
1880
|
}).input(z.object({
|
|
1472
1881
|
teamId: z.string().optional(),
|
|
@@ -1507,7 +1916,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1507
1916
|
isSecret: z.boolean(),
|
|
1508
1917
|
createdAt: z.coerce.date()
|
|
1509
1918
|
});
|
|
1510
|
-
const listEnvironmentVariablesContractV1 =
|
|
1919
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1511
1920
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1512
1921
|
method: "GET",
|
|
1513
1922
|
summary: "List environment variables",
|
|
@@ -1515,48 +1924,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1515
1924
|
tags: ["environments"],
|
|
1516
1925
|
successDescription: "The list of environment variables"
|
|
1517
1926
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1518
|
-
const createEnvironmentVariablesContractV1 =
|
|
1927
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1519
1928
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1520
1929
|
method: "POST",
|
|
1521
1930
|
summary: "Add environment variables",
|
|
1522
1931
|
description: "Add one or more environment variables to an environment",
|
|
1523
1932
|
tags: ["environments"],
|
|
1524
1933
|
successDescription: "The environment variables have been added successfully"
|
|
1525
|
-
}).errors({
|
|
1526
|
-
NOT_FOUND: {},
|
|
1527
|
-
BAD_REQUEST: {}
|
|
1528
|
-
}).input(z.object({
|
|
1934
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1529
1935
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1530
1936
|
environmentVariables: environmentVariablesSchema
|
|
1531
1937
|
})).output(z.object({ success: z.literal(true) }));
|
|
1532
|
-
const updateEnvironmentVariableContractV1 =
|
|
1938
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1533
1939
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1534
1940
|
method: "PATCH",
|
|
1535
1941
|
summary: "Update an environment variable",
|
|
1536
1942
|
description: "Update an environment variable by ID",
|
|
1537
1943
|
tags: ["environments"],
|
|
1538
1944
|
successDescription: "The environment variable has been updated successfully"
|
|
1539
|
-
}).errors({
|
|
1540
|
-
NOT_FOUND: {},
|
|
1541
|
-
BAD_REQUEST: {}
|
|
1542
|
-
}).input(z.object({
|
|
1945
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1543
1946
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1544
1947
|
key: environmentVariableSchema.shape.key,
|
|
1545
1948
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1546
1949
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1547
1950
|
})).output(z.object({ success: z.literal(true) }));
|
|
1548
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1951
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1549
1952
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1550
1953
|
method: "DELETE",
|
|
1551
1954
|
summary: "Delete an environment variable",
|
|
1552
1955
|
description: "Delete an environment variable by ID",
|
|
1553
1956
|
tags: ["environments"],
|
|
1554
1957
|
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({
|
|
1958
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1959
|
+
const deleteProjectContractV1 = base.route({
|
|
1560
1960
|
path: "/v1/projects/{projectId}",
|
|
1561
1961
|
method: "DELETE",
|
|
1562
1962
|
summary: "Delete a project",
|
|
@@ -1564,7 +1964,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1564
1964
|
tags: ["projects"],
|
|
1565
1965
|
successDescription: "The project has been deleted successfully"
|
|
1566
1966
|
}).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 =
|
|
1967
|
+
const updateProjectContractV1 = base.route({
|
|
1568
1968
|
path: "/v1/projects/{projectId}",
|
|
1569
1969
|
method: "PATCH",
|
|
1570
1970
|
summary: "Update a project",
|
|
@@ -1573,14 +1973,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1573
1973
|
successDescription: "The project has been updated successfully"
|
|
1574
1974
|
}).errors({
|
|
1575
1975
|
NOT_FOUND: {},
|
|
1576
|
-
BAD_REQUEST: {},
|
|
1577
1976
|
FORBIDDEN: {}
|
|
1578
1977
|
}).input(z.object({
|
|
1579
1978
|
projectId: z.string().describe("The ID of the project"),
|
|
1580
1979
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1581
1980
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1582
1981
|
})).output(projectOutputSchema);
|
|
1583
|
-
const deployEnvironmentContractV1 =
|
|
1982
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1584
1983
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1585
1984
|
method: "POST",
|
|
1586
1985
|
summary: "Deploy an environment",
|
|
@@ -1589,29 +1988,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1589
1988
|
successDescription: "The environment has been deployed successfully"
|
|
1590
1989
|
}).errors({
|
|
1591
1990
|
NOT_FOUND: {},
|
|
1592
|
-
BAD_REQUEST: {},
|
|
1593
1991
|
CONFLICT: {}
|
|
1594
1992
|
}).input(z.object({
|
|
1595
1993
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1596
1994
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1597
1995
|
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
1996
|
})).output(deploymentSchema);
|
|
1599
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1997
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1600
1998
|
path: "/v1/deployments/upload",
|
|
1601
1999
|
method: "POST",
|
|
1602
2000
|
summary: "Upload deployment artifacts",
|
|
1603
2001
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1604
2002
|
tags: ["deployments"],
|
|
1605
2003
|
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({
|
|
2004
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1610
2005
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1611
2006
|
token: z.string().describe("Token to identify the source archive"),
|
|
1612
2007
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1613
2008
|
}));
|
|
1614
|
-
const listDeploymentsContractV1 =
|
|
2009
|
+
const listDeploymentsContractV1 = base.route({
|
|
1615
2010
|
path: "/v1/projects/{projectId}/deployments",
|
|
1616
2011
|
method: "GET",
|
|
1617
2012
|
summary: "List project deployments",
|
|
@@ -1623,7 +2018,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1623
2018
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1624
2019
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1625
2020
|
})).output(z.array(deploymentSchema));
|
|
1626
|
-
const getDeploymentContractV1 =
|
|
2021
|
+
const getDeploymentContractV1 = base.route({
|
|
1627
2022
|
path: "/v1/deployments/{deploymentId}",
|
|
1628
2023
|
method: "GET",
|
|
1629
2024
|
summary: "Get a deployment",
|
|
@@ -1646,20 +2041,17 @@ const logEntrySchema = z.object({
|
|
|
1646
2041
|
method: z.string().optional(),
|
|
1647
2042
|
durationInMs: z.number().optional()
|
|
1648
2043
|
});
|
|
1649
|
-
const getLogsContractV1 =
|
|
2044
|
+
const getLogsContractV1 = base.route({
|
|
1650
2045
|
path: "/v1/environments/{environmentId}/logs",
|
|
1651
2046
|
method: "GET",
|
|
1652
2047
|
summary: "Get logs",
|
|
1653
2048
|
description: "Get logs for an environment",
|
|
1654
2049
|
tags: ["environments"],
|
|
1655
2050
|
successDescription: "The logs"
|
|
1656
|
-
}).errors({
|
|
1657
|
-
NOT_FOUND: {},
|
|
1658
|
-
BAD_REQUEST: {}
|
|
1659
|
-
}).input(z.object({
|
|
2051
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1660
2052
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1661
|
-
since:
|
|
1662
|
-
until:
|
|
2053
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2054
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1663
2055
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1664
2056
|
level: z.array(z.enum([
|
|
1665
2057
|
"INFO",
|
|
@@ -1673,17 +2065,14 @@ const getLogsContractV1 = oc.route({
|
|
|
1673
2065
|
logs: z.array(logEntrySchema),
|
|
1674
2066
|
nextToken: z.string().nullable()
|
|
1675
2067
|
}));
|
|
1676
|
-
const getLatestLogsContractV1 =
|
|
2068
|
+
const getLatestLogsContractV1 = base.route({
|
|
1677
2069
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1678
2070
|
method: "GET",
|
|
1679
2071
|
summary: "Get latest logs",
|
|
1680
2072
|
description: "Get the N most recent logs for an environment",
|
|
1681
2073
|
tags: ["environments"],
|
|
1682
2074
|
successDescription: "The latest logs"
|
|
1683
|
-
}).errors({
|
|
1684
|
-
NOT_FOUND: {},
|
|
1685
|
-
BAD_REQUEST: {}
|
|
1686
|
-
}).input(z.object({
|
|
2075
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1687
2076
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1688
2077
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1689
2078
|
level: z.array(z.enum([
|
|
@@ -1694,7 +2083,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1694
2083
|
])).optional().describe("Filter by log level"),
|
|
1695
2084
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1696
2085
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1697
|
-
const getDeploymentLogsContractV1 =
|
|
2086
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1698
2087
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1699
2088
|
method: "GET",
|
|
1700
2089
|
summary: "Get deployment logs",
|
|
@@ -1721,22 +2110,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1721
2110
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1722
2111
|
task_count: z.array(analyticsDataPointSchema)
|
|
1723
2112
|
});
|
|
1724
|
-
const getProjectAnalyticsContractV1 =
|
|
2113
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1725
2114
|
path: "/v1/analytics/{projectId}",
|
|
1726
2115
|
method: "GET",
|
|
1727
2116
|
summary: "Get project analytics",
|
|
1728
2117
|
description: "Get analytics data for a project over a time range",
|
|
1729
2118
|
tags: ["analytics"],
|
|
1730
2119
|
successDescription: "The project analytics data"
|
|
1731
|
-
}).errors({
|
|
1732
|
-
NOT_FOUND: {},
|
|
1733
|
-
BAD_REQUEST: {}
|
|
1734
|
-
}).input(z.object({
|
|
2120
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1735
2121
|
projectId: z.string().describe("The ID of the project"),
|
|
1736
2122
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1737
2123
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1738
2124
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1739
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2125
|
+
}).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({
|
|
1740
2126
|
metadata: z.object({
|
|
1741
2127
|
startTimestamp: z.number(),
|
|
1742
2128
|
endTimestamp: z.number(),
|
|
@@ -1746,7 +2132,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1746
2132
|
}),
|
|
1747
2133
|
timeSeries: analyticsTimeSeriesSchema
|
|
1748
2134
|
}));
|
|
1749
|
-
const
|
|
2135
|
+
const paginatedInsightsInputShape = {
|
|
2136
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2137
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2138
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2139
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2140
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2141
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2142
|
+
};
|
|
2143
|
+
const listIntentsContractV1 = base.route({
|
|
2144
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2145
|
+
method: "GET",
|
|
2146
|
+
summary: "List intents",
|
|
2147
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2148
|
+
tags: ["insights"],
|
|
2149
|
+
successDescription: "The grouped user intents"
|
|
2150
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2151
|
+
...paginatedInsightsInputShape,
|
|
2152
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2153
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2154
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2155
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2156
|
+
})).output(z.object({
|
|
2157
|
+
intents: z.array(z.object({
|
|
2158
|
+
id: z.string(),
|
|
2159
|
+
intentIds: z.array(z.string()).min(1),
|
|
2160
|
+
environmentId: z.string(),
|
|
2161
|
+
message: z.string(),
|
|
2162
|
+
toolName: z.string(),
|
|
2163
|
+
createdAt: z.coerce.date(),
|
|
2164
|
+
occurrenceCount: z.number().int().positive(),
|
|
2165
|
+
clientName: z.string().nullable(),
|
|
2166
|
+
clientId: z.string().nullable(),
|
|
2167
|
+
categories: z.array(z.object({
|
|
2168
|
+
id: z.string(),
|
|
2169
|
+
name: z.string(),
|
|
2170
|
+
color: intentCategoryColorSchema
|
|
2171
|
+
}))
|
|
2172
|
+
})),
|
|
2173
|
+
totalCount: z.number().int().nonnegative()
|
|
2174
|
+
}));
|
|
2175
|
+
const listFeedbacksContractV1 = base.route({
|
|
2176
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2177
|
+
method: "GET",
|
|
2178
|
+
summary: "List feedbacks",
|
|
2179
|
+
description: "List user feedback for an environment over a time range",
|
|
2180
|
+
tags: ["insights"],
|
|
2181
|
+
successDescription: "The user feedback"
|
|
2182
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2183
|
+
...paginatedInsightsInputShape,
|
|
2184
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2185
|
+
})).output(z.object({
|
|
2186
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2187
|
+
totalCount: z.number().int().nonnegative()
|
|
2188
|
+
}));
|
|
2189
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2190
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2191
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2192
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2193
|
+
method: "GET",
|
|
2194
|
+
summary: "List intent categories",
|
|
2195
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2196
|
+
tags: ["insights"],
|
|
2197
|
+
successDescription: "The intent categories"
|
|
2198
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2199
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2200
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2201
|
+
method: "POST",
|
|
2202
|
+
summary: "Create an intent category",
|
|
2203
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2204
|
+
tags: ["insights"],
|
|
2205
|
+
successDescription: "The created intent category"
|
|
2206
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2207
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2208
|
+
name: intentCategoryNameSchema,
|
|
2209
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2210
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2211
|
+
})).output(intentCategorySchema);
|
|
2212
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2213
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2214
|
+
method: "PATCH",
|
|
2215
|
+
summary: "Update an intent category",
|
|
2216
|
+
description: "Rename or recolor an intent category",
|
|
2217
|
+
tags: ["insights"],
|
|
2218
|
+
successDescription: "The updated intent category"
|
|
2219
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2220
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2221
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2222
|
+
name: intentCategoryNameSchema.optional(),
|
|
2223
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2224
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2225
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2226
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2227
|
+
method: "DELETE",
|
|
2228
|
+
summary: "Delete an intent category",
|
|
2229
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2230
|
+
tags: ["insights"],
|
|
2231
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2232
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2233
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2234
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2235
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2236
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2237
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2238
|
+
method: "POST",
|
|
2239
|
+
summary: "Link an intent category",
|
|
2240
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2241
|
+
tags: ["insights"],
|
|
2242
|
+
successDescription: "The intents have been linked successfully"
|
|
2243
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2244
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2245
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2246
|
+
intentIds: categorizableIntentIdsSchema
|
|
2247
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2248
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2249
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2250
|
+
method: "POST",
|
|
2251
|
+
summary: "Unlink an intent category",
|
|
2252
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2253
|
+
tags: ["insights"],
|
|
2254
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2255
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2256
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2257
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2258
|
+
intentIds: categorizableIntentIdsSchema
|
|
2259
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2260
|
+
const listTeamsContractV1 = base.route({
|
|
1750
2261
|
path: "/v1/teams",
|
|
1751
2262
|
method: "GET",
|
|
1752
2263
|
summary: "List teams",
|
|
@@ -1759,7 +2270,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1759
2270
|
createdAt: z.coerce.date(),
|
|
1760
2271
|
hasStripeAccount: z.boolean()
|
|
1761
2272
|
})));
|
|
1762
|
-
const
|
|
2273
|
+
const getTeamUsageContractV1 = base.route({
|
|
2274
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2275
|
+
method: "GET",
|
|
2276
|
+
summary: "Get team usage",
|
|
2277
|
+
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.",
|
|
2278
|
+
tags: ["teams"],
|
|
2279
|
+
successDescription: "The current billing window usage"
|
|
2280
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2281
|
+
teamId: z.string(),
|
|
2282
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2283
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2284
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2285
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2286
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2287
|
+
}));
|
|
2288
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1763
2289
|
path: "/v1/tunnels/ticket",
|
|
1764
2290
|
method: "GET",
|
|
1765
2291
|
summary: "Get a tunnel ticket",
|
|
@@ -1771,16 +2297,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1771
2297
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1772
2298
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1773
2299
|
}));
|
|
1774
|
-
const publishServerContractV1 =
|
|
2300
|
+
const publishServerContractV1 = base.route({
|
|
1775
2301
|
path: "/v1/distribution/publish",
|
|
1776
2302
|
method: "POST",
|
|
1777
2303
|
summary: "Publish a server to the MCP registry",
|
|
1778
2304
|
tags: ["distribution"],
|
|
1779
2305
|
successDescription: "The server has been published successfully"
|
|
1780
|
-
}).errors({
|
|
1781
|
-
NOT_FOUND: {},
|
|
1782
|
-
BAD_REQUEST: {}
|
|
1783
|
-
}).input(z.object({
|
|
2306
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1784
2307
|
projectId: z.string(),
|
|
1785
2308
|
domain: z.string(),
|
|
1786
2309
|
title: z.string().min(1).max(100),
|
|
@@ -1789,17 +2312,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1789
2312
|
iconSrc: z.url().max(255).optional(),
|
|
1790
2313
|
dryRun: z.boolean().optional()
|
|
1791
2314
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1792
|
-
const getServerInfoContractV1 =
|
|
2315
|
+
const getServerInfoContractV1 = base.route({
|
|
1793
2316
|
path: "/v1/distribution/get",
|
|
1794
2317
|
method: "GET",
|
|
1795
2318
|
summary: "Get server info",
|
|
1796
2319
|
description: "Get info about a server",
|
|
1797
2320
|
tags: ["distribution"],
|
|
1798
2321
|
successDescription: "The server info"
|
|
1799
|
-
}).errors({
|
|
1800
|
-
NOT_FOUND: {},
|
|
1801
|
-
BAD_REQUEST: {}
|
|
1802
|
-
}).input(z.object({
|
|
2322
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1803
2323
|
projectId: z.string(),
|
|
1804
2324
|
domain: z.string()
|
|
1805
2325
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1818,7 +2338,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1818
2338
|
isPlaygroundEnabled: z.boolean(),
|
|
1819
2339
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1820
2340
|
});
|
|
1821
|
-
const getPlaygroundContractV1 =
|
|
2341
|
+
const getPlaygroundContractV1 = base.route({
|
|
1822
2342
|
path: "/v1/environments/{environmentId}/playground",
|
|
1823
2343
|
method: "GET",
|
|
1824
2344
|
summary: "Get playground configuration",
|
|
@@ -1826,17 +2346,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1826
2346
|
tags: ["environments"],
|
|
1827
2347
|
successDescription: "The playground configuration"
|
|
1828
2348
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1829
|
-
const upsertPlaygroundContractV1 =
|
|
2349
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1830
2350
|
path: "/v1/environments/{environmentId}/playground",
|
|
1831
2351
|
method: "PUT",
|
|
1832
2352
|
summary: "Update playground configuration",
|
|
1833
2353
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1834
2354
|
tags: ["environments"],
|
|
1835
2355
|
successDescription: "The updated playground configuration"
|
|
1836
|
-
}).errors({
|
|
1837
|
-
NOT_FOUND: {},
|
|
1838
|
-
BAD_REQUEST: {}
|
|
1839
|
-
}).input(z.object({
|
|
2356
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1840
2357
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1841
2358
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1842
2359
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1844,7 +2361,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1844
2361
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1845
2362
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1846
2363
|
})).output(playgroundOutputSchema);
|
|
1847
|
-
const createBeaconContractV1 =
|
|
2364
|
+
const createBeaconContractV1 = base.route({
|
|
1848
2365
|
path: "/v1/beacon/audits",
|
|
1849
2366
|
method: "POST",
|
|
1850
2367
|
summary: "Create a beacon audit",
|
|
@@ -1853,7 +2370,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1853
2370
|
successDescription: "The audit has been created"
|
|
1854
2371
|
}).errors({
|
|
1855
2372
|
NOT_FOUND: {},
|
|
1856
|
-
BAD_REQUEST: {},
|
|
1857
2373
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1858
2374
|
}).input(z.object({
|
|
1859
2375
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1861,7 +2377,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1861
2377
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1862
2378
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1863
2379
|
})).output(z.object({ id: z.string() }));
|
|
1864
|
-
const getBeaconContractV1 =
|
|
2380
|
+
const getBeaconContractV1 = base.route({
|
|
1865
2381
|
path: "/v1/beacon/audits/{auditId}",
|
|
1866
2382
|
method: "GET",
|
|
1867
2383
|
summary: "Get a beacon audit",
|
|
@@ -1876,9 +2392,73 @@ const getBeaconContractV1 = oc.route({
|
|
|
1876
2392
|
createdAt: z.coerce.date(),
|
|
1877
2393
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1878
2394
|
}));
|
|
2395
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2396
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2397
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2398
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2399
|
+
const createSubmissionContractV1 = base.route({
|
|
2400
|
+
path: "/v1/submissions",
|
|
2401
|
+
method: "POST",
|
|
2402
|
+
summary: "Create a submission package",
|
|
2403
|
+
description: "Create a submission package for an environment. Alpic reads the environment's live MCP server and prefills every field it can infer, so the response already carries the populated package. The environment must have a successful deployment and must not require authentication.",
|
|
2404
|
+
tags: ["submissions"],
|
|
2405
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2406
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2407
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2408
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2409
|
+
})).output(submissionSchema);
|
|
2410
|
+
const listSubmissionsContractV1 = base.route({
|
|
2411
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2412
|
+
method: "GET",
|
|
2413
|
+
summary: "List submission packages",
|
|
2414
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2415
|
+
tags: ["submissions"],
|
|
2416
|
+
successDescription: "The list of submission packages"
|
|
2417
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2418
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2419
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2420
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2421
|
+
})).output(z.array(submissionSchema));
|
|
2422
|
+
const getSubmissionContractV1 = base.route({
|
|
2423
|
+
path: "/v1/submissions/{submissionId}",
|
|
2424
|
+
method: "GET",
|
|
2425
|
+
summary: "Get a submission package",
|
|
2426
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2427
|
+
tags: ["submissions"],
|
|
2428
|
+
successDescription: "The submission package"
|
|
2429
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2430
|
+
const updateSubmissionContractV1 = base.route({
|
|
2431
|
+
path: "/v1/submissions/{submissionId}",
|
|
2432
|
+
method: "PUT",
|
|
2433
|
+
summary: "Update a submission package",
|
|
2434
|
+
description: "Update the form data of a submission package. Only the fields you send are changed; the rest are left as they are. Unknown field names are rejected rather than ignored, so a typo fails the call. `platform` must match the package's own platform.",
|
|
2435
|
+
tags: ["submissions"],
|
|
2436
|
+
successDescription: "The updated submission package"
|
|
2437
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2438
|
+
submissionId: submissionIdSchema,
|
|
2439
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2440
|
+
formData: claudeSubmissionUpdateSchema
|
|
2441
|
+
}), z.object({
|
|
2442
|
+
submissionId: submissionIdSchema,
|
|
2443
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2444
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2445
|
+
})])).output(submissionSchema);
|
|
1879
2446
|
const contract = {
|
|
1880
|
-
teams: {
|
|
2447
|
+
teams: {
|
|
2448
|
+
list: { v1: listTeamsContractV1 },
|
|
2449
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2450
|
+
},
|
|
1881
2451
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2452
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2453
|
+
intentCategories: {
|
|
2454
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2455
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2456
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2457
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2458
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2459
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2460
|
+
},
|
|
2461
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1882
2462
|
deployments: {
|
|
1883
2463
|
list: { v1: listDeploymentsContractV1 },
|
|
1884
2464
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1888,6 +2468,7 @@ const contract = {
|
|
|
1888
2468
|
environments: {
|
|
1889
2469
|
create: { v1: createEnvironmentContractV1 },
|
|
1890
2470
|
get: { v1: getEnvironmentContractV1 },
|
|
2471
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1891
2472
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1892
2473
|
getLogs: { v1: getLogsContractV1 },
|
|
1893
2474
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1917,6 +2498,12 @@ const contract = {
|
|
|
1917
2498
|
beacon: {
|
|
1918
2499
|
create: { v1: createBeaconContractV1 },
|
|
1919
2500
|
get: { v1: getBeaconContractV1 }
|
|
2501
|
+
},
|
|
2502
|
+
submissions: {
|
|
2503
|
+
create: { v1: createSubmissionContractV1 },
|
|
2504
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2505
|
+
get: { v1: getSubmissionContractV1 },
|
|
2506
|
+
update: { v1: updateSubmissionContractV1 }
|
|
1920
2507
|
}
|
|
1921
2508
|
};
|
|
1922
2509
|
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
@@ -1924,5 +2511,26 @@ const contractForDocs = {
|
|
|
1924
2511
|
...contract,
|
|
1925
2512
|
deployments: deploymentsForDocs
|
|
1926
2513
|
};
|
|
2514
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2515
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2516
|
+
info: {
|
|
2517
|
+
title: "Alpic API",
|
|
2518
|
+
version: "1.0.0"
|
|
2519
|
+
},
|
|
2520
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2521
|
+
security: [{ bearerAuth: [] }],
|
|
2522
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2523
|
+
type: "http",
|
|
2524
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2525
|
+
scheme: "bearer"
|
|
2526
|
+
} } },
|
|
2527
|
+
commonSchemas: {
|
|
2528
|
+
Submission: { schema: submissionSchema },
|
|
2529
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2530
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2531
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2532
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
2533
|
+
}
|
|
2534
|
+
};
|
|
1927
2535
|
//#endregion
|
|
1928
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2536
|
+
export { AI_PLATFORMS, AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, OPENAPI_DOC_OPTIONS, PLATFORM_LABELS, buildSettingsSchema, chatgptSubmissionUpdateSchema, claudeSubmissionUpdateSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|