@alpic-ai/api 0.0.0-dev.gf1a4fb0 → 0.0.0-dev.gf1d163d
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 +6284 -94
- package/dist/index.mjs +776 -176
- package/package.json +9 -9
package/dist/index.mjs
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
import * as z$1 from "zod/v4";
|
|
3
3
|
import { oc } from "@orpc/contract";
|
|
4
4
|
import ms from "ms";
|
|
5
|
-
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.1_supports-color@7.2.0_zod@4.5.4/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -179,6 +179,7 @@ const PLATFORM_LABELS = {
|
|
|
179
179
|
};
|
|
180
180
|
const WAF_PLATFORMS = [
|
|
181
181
|
"akamai",
|
|
182
|
+
"cato",
|
|
182
183
|
"cloudflare",
|
|
183
184
|
"fastly"
|
|
184
185
|
];
|
|
@@ -256,6 +257,25 @@ z.object({
|
|
|
256
257
|
clientSecret: z.string(),
|
|
257
258
|
clientScopes: z.array(z.string())
|
|
258
259
|
});
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"admin_adjustment"
|
|
266
|
+
]);
|
|
267
|
+
z.enum(["playground"]);
|
|
268
|
+
z.number().int().min(500);
|
|
269
|
+
const creditActivityEntrySchema = z.object({
|
|
270
|
+
reason: creditEntryReasonSchema,
|
|
271
|
+
day: z.number(),
|
|
272
|
+
amountInNanoUSD: z.number(),
|
|
273
|
+
messageCount: z.number().nullable()
|
|
274
|
+
});
|
|
275
|
+
z.object({
|
|
276
|
+
balanceInNanoUSD: z.number(),
|
|
277
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
278
|
+
});
|
|
259
279
|
const deploymentStatusSchema$1 = z.enum([
|
|
260
280
|
"ongoing",
|
|
261
281
|
"deployed",
|
|
@@ -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({}),
|
|
@@ -425,14 +419,17 @@ z.object({
|
|
|
425
419
|
collectRequestPayload: z.boolean(),
|
|
426
420
|
collectResponsePayload: z.boolean(),
|
|
427
421
|
collectErrorMessage: z.boolean(),
|
|
428
|
-
collectUserData: z.boolean()
|
|
422
|
+
collectUserData: z.boolean(),
|
|
423
|
+
identityTraitKey: z.string().min(1).max(200).nullable(),
|
|
424
|
+
leadEventName: z.string().min(1).max(200).nullable()
|
|
429
425
|
});
|
|
430
|
-
z.object({
|
|
426
|
+
const feedbackSchema = z.object({
|
|
431
427
|
id: z.string(),
|
|
432
428
|
createdAt: z.coerce.date(),
|
|
433
429
|
environmentId: z.string(),
|
|
434
430
|
content: z.string(),
|
|
435
|
-
source: z.enum(["model", "user"])
|
|
431
|
+
source: z.enum(["model", "user"]),
|
|
432
|
+
clientName: z.string().nullable()
|
|
436
433
|
});
|
|
437
434
|
z.object({
|
|
438
435
|
content: z.string(),
|
|
@@ -448,7 +445,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
448
445
|
"pink",
|
|
449
446
|
"gray"
|
|
450
447
|
]);
|
|
451
|
-
intentCategoryColorSchema.options;
|
|
448
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
452
449
|
const intentCategorySchema = z.object({
|
|
453
450
|
id: z.string(),
|
|
454
451
|
createdAt: z.coerce.date(),
|
|
@@ -456,7 +453,7 @@ const intentCategorySchema = z.object({
|
|
|
456
453
|
name: z.string(),
|
|
457
454
|
color: intentCategoryColorSchema
|
|
458
455
|
});
|
|
459
|
-
z.object({
|
|
456
|
+
const intentCategorySummarySchema = z.object({
|
|
460
457
|
id: z.string(),
|
|
461
458
|
name: z.string(),
|
|
462
459
|
color: intentCategoryColorSchema,
|
|
@@ -468,6 +465,7 @@ z.object({
|
|
|
468
465
|
environmentId: z.string(),
|
|
469
466
|
toolName: z.string(),
|
|
470
467
|
message: z.string(),
|
|
468
|
+
clientName: z.string().nullable(),
|
|
471
469
|
categories: z.array(intentCategorySchema)
|
|
472
470
|
});
|
|
473
471
|
const signalCategorySchema = z.object({
|
|
@@ -526,12 +524,270 @@ z.object({
|
|
|
526
524
|
createdAt: z.coerce.date(),
|
|
527
525
|
updatedAt: z.coerce.date()
|
|
528
526
|
});
|
|
527
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
528
|
+
type: z.literal("mcp_request"),
|
|
529
|
+
method: z.string()
|
|
530
|
+
});
|
|
531
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
532
|
+
type: z.literal("mcp_error"),
|
|
533
|
+
method: z.string(),
|
|
534
|
+
error: z.string()
|
|
535
|
+
});
|
|
536
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
529
537
|
z.enum([
|
|
530
538
|
"INFO",
|
|
531
539
|
"WARNING",
|
|
532
540
|
"DEBUG",
|
|
533
541
|
"ERROR"
|
|
534
542
|
]);
|
|
543
|
+
const LOG_SEARCH_MAX_ESCAPED_LENGTH = 960;
|
|
544
|
+
function escapeLogSearchTerm(search) {
|
|
545
|
+
return [...search].flatMap((character) => [...new TextEncoder().encode(character)]).map((byte) => {
|
|
546
|
+
const character = String.fromCharCode(byte);
|
|
547
|
+
return /^[a-zA-Z0-9]$/.test(character) ? character : `\\x${byte.toString(16).toUpperCase().padStart(2, "0")}`;
|
|
548
|
+
}).join("");
|
|
549
|
+
}
|
|
550
|
+
const logSearchSchema = z.string().max(240, `Search must be 240 characters or fewer`).refine((search) => escapeLogSearchTerm(search).length <= LOG_SEARCH_MAX_ESCAPED_LENGTH, "Search is too complex; shorten it or use fewer special characters");
|
|
551
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
552
|
+
const MCP_CLIENT_GROUPS = [
|
|
553
|
+
{
|
|
554
|
+
id: "claude_code",
|
|
555
|
+
label: "Claude Code",
|
|
556
|
+
vendor: "anthropic",
|
|
557
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
id: "claude",
|
|
561
|
+
label: "Claude",
|
|
562
|
+
vendor: "anthropic",
|
|
563
|
+
rawNames: [
|
|
564
|
+
"Anthropic/ClaudeAI",
|
|
565
|
+
"claude-ai",
|
|
566
|
+
"claude",
|
|
567
|
+
"Claude",
|
|
568
|
+
"claude-desktop",
|
|
569
|
+
"claude-desktop-3p"
|
|
570
|
+
]
|
|
571
|
+
},
|
|
572
|
+
{
|
|
573
|
+
id: "claude_mobile",
|
|
574
|
+
label: "Claude mobile",
|
|
575
|
+
vendor: "anthropic",
|
|
576
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
577
|
+
},
|
|
578
|
+
{
|
|
579
|
+
id: "claude_cowork",
|
|
580
|
+
label: "Claude Cowork",
|
|
581
|
+
vendor: "anthropic",
|
|
582
|
+
rawNames: ["Anthropic/Cowork"]
|
|
583
|
+
},
|
|
584
|
+
{
|
|
585
|
+
id: "claude_toolbox",
|
|
586
|
+
label: "Claude Toolbox",
|
|
587
|
+
vendor: "anthropic",
|
|
588
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
589
|
+
},
|
|
590
|
+
{
|
|
591
|
+
id: "anthropic_api",
|
|
592
|
+
label: "Anthropic API",
|
|
593
|
+
vendor: "anthropic",
|
|
594
|
+
rawNames: ["Anthropic/API"]
|
|
595
|
+
},
|
|
596
|
+
{
|
|
597
|
+
id: "anthropic_connector_refresh",
|
|
598
|
+
label: "Anthropic (connector refresh)",
|
|
599
|
+
vendor: "anthropic",
|
|
600
|
+
rawNames: ["Anthropic"]
|
|
601
|
+
},
|
|
602
|
+
{
|
|
603
|
+
id: "codex",
|
|
604
|
+
label: "Codex",
|
|
605
|
+
vendor: "openai",
|
|
606
|
+
rawNames: [
|
|
607
|
+
"codex-mcp-client",
|
|
608
|
+
"codex",
|
|
609
|
+
"Codex",
|
|
610
|
+
"codex-cli",
|
|
611
|
+
"openai-mcp (Codex)"
|
|
612
|
+
]
|
|
613
|
+
},
|
|
614
|
+
{
|
|
615
|
+
id: "chatgpt",
|
|
616
|
+
label: "ChatGPT",
|
|
617
|
+
vendor: "openai",
|
|
618
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
619
|
+
},
|
|
620
|
+
{
|
|
621
|
+
id: "openai_responses_api",
|
|
622
|
+
label: "OpenAI Responses API",
|
|
623
|
+
vendor: "openai",
|
|
624
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
625
|
+
},
|
|
626
|
+
{
|
|
627
|
+
id: "openai_agent_builder",
|
|
628
|
+
label: "OpenAI Agent Builder",
|
|
629
|
+
vendor: "openai",
|
|
630
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
631
|
+
},
|
|
632
|
+
{
|
|
633
|
+
id: "openai_other",
|
|
634
|
+
label: "OpenAI Other",
|
|
635
|
+
vendor: "openai",
|
|
636
|
+
rawNames: ["openai-mcp"]
|
|
637
|
+
},
|
|
638
|
+
{
|
|
639
|
+
id: "cursor",
|
|
640
|
+
label: "Cursor",
|
|
641
|
+
vendor: "cursor",
|
|
642
|
+
rawNames: [
|
|
643
|
+
"cursor-vscode",
|
|
644
|
+
"Cursor",
|
|
645
|
+
"cursor"
|
|
646
|
+
]
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
id: "cline",
|
|
650
|
+
label: "Cline",
|
|
651
|
+
vendor: "cline",
|
|
652
|
+
rawNames: [
|
|
653
|
+
"Cline",
|
|
654
|
+
"cline",
|
|
655
|
+
"@cline/core"
|
|
656
|
+
]
|
|
657
|
+
},
|
|
658
|
+
{
|
|
659
|
+
id: "github_copilot",
|
|
660
|
+
label: "GitHub Copilot",
|
|
661
|
+
vendor: "githubCopilot",
|
|
662
|
+
rawNames: [
|
|
663
|
+
"Copilot",
|
|
664
|
+
"github-copilot-developer",
|
|
665
|
+
"Copilot MCP Gateway",
|
|
666
|
+
"Xcode/copilot-xcode"
|
|
667
|
+
]
|
|
668
|
+
},
|
|
669
|
+
{
|
|
670
|
+
id: "gemini_cli",
|
|
671
|
+
label: "Gemini CLI",
|
|
672
|
+
vendor: "google",
|
|
673
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
674
|
+
},
|
|
675
|
+
{
|
|
676
|
+
id: "antigravity",
|
|
677
|
+
label: "Antigravity",
|
|
678
|
+
vendor: "google",
|
|
679
|
+
rawNames: ["antigravity-client"]
|
|
680
|
+
},
|
|
681
|
+
{
|
|
682
|
+
id: "gemini",
|
|
683
|
+
label: "Gemini",
|
|
684
|
+
vendor: "google",
|
|
685
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
686
|
+
},
|
|
687
|
+
{
|
|
688
|
+
id: "windsurf",
|
|
689
|
+
label: "Windsurf",
|
|
690
|
+
vendor: "windsurf",
|
|
691
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
692
|
+
},
|
|
693
|
+
{
|
|
694
|
+
id: "mistral",
|
|
695
|
+
label: "Mistral / Le Chat",
|
|
696
|
+
vendor: "mistral",
|
|
697
|
+
rawNames: ["Mistral"],
|
|
698
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
699
|
+
},
|
|
700
|
+
{
|
|
701
|
+
id: "n8n",
|
|
702
|
+
label: "n8n",
|
|
703
|
+
vendor: "n8n",
|
|
704
|
+
rawNames: [
|
|
705
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
706
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
707
|
+
"n8n"
|
|
708
|
+
]
|
|
709
|
+
},
|
|
710
|
+
{
|
|
711
|
+
id: "alpic_playground",
|
|
712
|
+
label: "Alpic Playground",
|
|
713
|
+
vendor: "alpic",
|
|
714
|
+
rawNames: ["alpic-playground", "playground"]
|
|
715
|
+
},
|
|
716
|
+
{
|
|
717
|
+
id: "opencode",
|
|
718
|
+
label: "opencode",
|
|
719
|
+
vendor: "opencode",
|
|
720
|
+
rawNames: ["opencode"]
|
|
721
|
+
},
|
|
722
|
+
{
|
|
723
|
+
id: "zed",
|
|
724
|
+
label: "Zed",
|
|
725
|
+
vendor: "zed",
|
|
726
|
+
rawNames: ["Zed", "zed"]
|
|
727
|
+
},
|
|
728
|
+
{
|
|
729
|
+
id: "zapier",
|
|
730
|
+
label: "Zapier",
|
|
731
|
+
vendor: "zapier",
|
|
732
|
+
rawNames: ["Zapier", "zapier"]
|
|
733
|
+
},
|
|
734
|
+
{
|
|
735
|
+
id: "make",
|
|
736
|
+
label: "Make",
|
|
737
|
+
vendor: "make",
|
|
738
|
+
rawNames: ["Make", "make"]
|
|
739
|
+
},
|
|
740
|
+
{
|
|
741
|
+
id: "librechat",
|
|
742
|
+
label: "LibreChat",
|
|
743
|
+
vendor: "mcp",
|
|
744
|
+
rawNames: ["LibreChat", "librechat"]
|
|
745
|
+
},
|
|
746
|
+
{
|
|
747
|
+
id: "jan",
|
|
748
|
+
label: "Jan",
|
|
749
|
+
vendor: "mcp",
|
|
750
|
+
rawNames: ["Jan", "jan"]
|
|
751
|
+
},
|
|
752
|
+
{
|
|
753
|
+
id: "goose",
|
|
754
|
+
label: "goose",
|
|
755
|
+
vendor: "mcp",
|
|
756
|
+
rawNames: ["goose", "Goose"]
|
|
757
|
+
},
|
|
758
|
+
{
|
|
759
|
+
id: "mcphost",
|
|
760
|
+
label: "mcphost",
|
|
761
|
+
vendor: "mcp",
|
|
762
|
+
rawNames: ["mcphost"]
|
|
763
|
+
},
|
|
764
|
+
{
|
|
765
|
+
id: "mcporter",
|
|
766
|
+
label: "mcporter",
|
|
767
|
+
vendor: "mcp",
|
|
768
|
+
rawNames: ["mcporter"]
|
|
769
|
+
},
|
|
770
|
+
{
|
|
771
|
+
id: "rmcp",
|
|
772
|
+
label: "rmcp",
|
|
773
|
+
vendor: "mcp",
|
|
774
|
+
rawNames: ["rmcp"]
|
|
775
|
+
},
|
|
776
|
+
{
|
|
777
|
+
id: "unnamed_client",
|
|
778
|
+
label: "Unnamed client",
|
|
779
|
+
vendor: "mcp",
|
|
780
|
+
rawNames: [
|
|
781
|
+
"mcp",
|
|
782
|
+
"unknown",
|
|
783
|
+
""
|
|
784
|
+
]
|
|
785
|
+
}
|
|
786
|
+
];
|
|
787
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
788
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
789
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
790
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
535
791
|
const runtimeSchema = z.enum([
|
|
536
792
|
"python3.13",
|
|
537
793
|
"python3.14",
|
|
@@ -609,15 +865,7 @@ z.object({
|
|
|
609
865
|
serverFields: serverFieldsSchema$1,
|
|
610
866
|
source: z.enum(["registry", "defaults"])
|
|
611
867
|
});
|
|
612
|
-
/**
|
|
613
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
614
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
615
|
-
*
|
|
616
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
617
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
618
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
619
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
620
|
-
*/
|
|
868
|
+
/** 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. */
|
|
621
869
|
const clampStringField = (field) => {
|
|
622
870
|
const max = field.maxLength;
|
|
623
871
|
if (max === null) return field;
|
|
@@ -625,6 +873,10 @@ const clampStringField = (field) => {
|
|
|
625
873
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
626
874
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
627
875
|
};
|
|
876
|
+
const unboundedArrayField = (field) => {
|
|
877
|
+
const unbounded = z.array(field.element);
|
|
878
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
879
|
+
};
|
|
628
880
|
const toolDefinitionSchema = z.object({
|
|
629
881
|
name: z.string(),
|
|
630
882
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -637,11 +889,22 @@ const toolDefinitionSchema = z.object({
|
|
|
637
889
|
}).optional()
|
|
638
890
|
});
|
|
639
891
|
const positiveTestCaseSchema = z.object({
|
|
640
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
641
|
-
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."),
|
|
892
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
893
|
+
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."),
|
|
642
894
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
643
895
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
644
|
-
}).
|
|
896
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
897
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
898
|
+
scenario: z.string().optional(),
|
|
899
|
+
userPrompt: z.string().optional()
|
|
900
|
+
});
|
|
901
|
+
const blankPositiveTestCase = () => ({
|
|
902
|
+
scenario: "",
|
|
903
|
+
userPrompt: "",
|
|
904
|
+
toolTriggered: "",
|
|
905
|
+
expectedOutput: ""
|
|
906
|
+
});
|
|
907
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
645
908
|
const screenshotEntrySchema = z.object({
|
|
646
909
|
prompt: z.string(),
|
|
647
910
|
url: z.url()
|
|
@@ -954,20 +1217,25 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
954
1217
|
"zh-TW"
|
|
955
1218
|
]);
|
|
956
1219
|
const negativeTestCaseSchema = z.object({
|
|
957
|
-
scenario: z.string(),
|
|
958
|
-
userPrompt: z.string()
|
|
959
|
-
}).
|
|
1220
|
+
scenario: z.string().min(1),
|
|
1221
|
+
userPrompt: z.string().min(1)
|
|
1222
|
+
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1223
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1224
|
+
scenario: z.string().optional(),
|
|
1225
|
+
userPrompt: z.string().optional()
|
|
1226
|
+
});
|
|
1227
|
+
const blankNegativeTestCase = () => ({
|
|
1228
|
+
scenario: "",
|
|
1229
|
+
userPrompt: ""
|
|
1230
|
+
});
|
|
1231
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
960
1232
|
const chatgptToolJustificationSchema = z.object({
|
|
961
1233
|
toolName: z.string(),
|
|
962
1234
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
963
1235
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
964
1236
|
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.\"")
|
|
965
1237
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
966
|
-
/**
|
|
967
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
968
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
969
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
970
|
-
*/
|
|
1238
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
971
1239
|
const chatgptTaglineSchema = z.string().max(30);
|
|
972
1240
|
const chatgptDescriptionSchema = z.string();
|
|
973
1241
|
const chatgptTranslationSchema = z.object({
|
|
@@ -976,10 +1244,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
976
1244
|
description: chatgptDescriptionSchema
|
|
977
1245
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
978
1246
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
979
|
-
/**
|
|
980
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
981
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
982
|
-
*/
|
|
1247
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
983
1248
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
984
1249
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
985
1250
|
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."),
|
|
@@ -998,8 +1263,9 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
998
1263
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
999
1264
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1000
1265
|
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."),
|
|
1001
|
-
|
|
1002
|
-
|
|
1266
|
+
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."),
|
|
1267
|
+
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."),
|
|
1268
|
+
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."),
|
|
1003
1269
|
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."),
|
|
1004
1270
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1005
1271
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
@@ -1014,23 +1280,35 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
1014
1280
|
demoRecordingUrl: z.string().optional(),
|
|
1015
1281
|
serverUrl: z.string().optional(),
|
|
1016
1282
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1283
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1284
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1017
1285
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1018
1286
|
});
|
|
1019
|
-
|
|
1287
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1288
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1020
1289
|
appName: true,
|
|
1021
1290
|
developerName: true,
|
|
1022
1291
|
serverUrl: true,
|
|
1023
1292
|
tools: true,
|
|
1293
|
+
skills: true,
|
|
1024
1294
|
authentication: true
|
|
1025
1295
|
});
|
|
1026
|
-
|
|
1296
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1297
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1027
1298
|
tagline: true,
|
|
1028
1299
|
description: true,
|
|
1029
1300
|
category: true,
|
|
1030
1301
|
testCases: true,
|
|
1031
1302
|
negativeTestCases: true,
|
|
1032
1303
|
toolJustifications: true
|
|
1033
|
-
}).extend({
|
|
1304
|
+
}).extend({
|
|
1305
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1306
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1307
|
+
}).extend({
|
|
1308
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1309
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1310
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1311
|
+
});
|
|
1034
1312
|
const claudeCategorySchema = z.enum([
|
|
1035
1313
|
"Productivity",
|
|
1036
1314
|
"Communication",
|
|
@@ -1076,11 +1354,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1076
1354
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1077
1355
|
"Public documentation for this connector will be live by the publish date."
|
|
1078
1356
|
]);
|
|
1079
|
-
/**
|
|
1080
|
-
* Field order mirrors the claude.ai directory submission wizard
|
|
1081
|
-
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1082
|
-
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1083
|
-
*/
|
|
1357
|
+
/** 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. */
|
|
1084
1358
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1085
1359
|
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
|
|
1086
1360
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1157,7 +1431,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1157
1431
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1158
1432
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1159
1433
|
});
|
|
1160
|
-
|
|
1434
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1435
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1161
1436
|
serverUrl: true,
|
|
1162
1437
|
name: true,
|
|
1163
1438
|
slug: true,
|
|
@@ -1172,39 +1447,93 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1172
1447
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1173
1448
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1174
1449
|
});
|
|
1175
|
-
/**
|
|
1176
|
-
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1177
|
-
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1178
|
-
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1179
|
-
* colocated with the Claude contract.
|
|
1180
|
-
*/
|
|
1450
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1181
1451
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1182
1452
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1183
1453
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1184
1454
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1185
1455
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1186
1456
|
});
|
|
1187
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1457
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1188
1458
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1189
1459
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1190
1460
|
});
|
|
1461
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1462
|
+
const byField = {};
|
|
1463
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1464
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1465
|
+
return byField;
|
|
1466
|
+
}
|
|
1467
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1468
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1469
|
+
"pass",
|
|
1470
|
+
"fail",
|
|
1471
|
+
"unverified"
|
|
1472
|
+
]);
|
|
1473
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1474
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1475
|
+
claudeai: ["privacyPolicy"]
|
|
1476
|
+
};
|
|
1477
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1478
|
+
const policyDisclosureSchema = z.enum([
|
|
1479
|
+
"dataCategories",
|
|
1480
|
+
"purposesOfUse",
|
|
1481
|
+
"recipients",
|
|
1482
|
+
"retention"
|
|
1483
|
+
]);
|
|
1484
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1485
|
+
field: verifiableUrlFieldSchema,
|
|
1486
|
+
url: z.string(),
|
|
1487
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1488
|
+
reason: z.string(),
|
|
1489
|
+
concerns: z.array(z.string()).optional(),
|
|
1490
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1491
|
+
});
|
|
1492
|
+
const urlVerificationSchema = z.object({
|
|
1493
|
+
verifiedAt: z.coerce.date(),
|
|
1494
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1495
|
+
});
|
|
1496
|
+
const pageKindSchema = z.enum([
|
|
1497
|
+
"expectedDocument",
|
|
1498
|
+
"errorPage",
|
|
1499
|
+
"loginWall",
|
|
1500
|
+
"parkedDomain",
|
|
1501
|
+
"comingSoon",
|
|
1502
|
+
"marketingPage",
|
|
1503
|
+
"unrelatedDocument"
|
|
1504
|
+
]);
|
|
1505
|
+
z.object({
|
|
1506
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1507
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1508
|
+
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.")
|
|
1509
|
+
});
|
|
1191
1510
|
const submissionMetaFieldsSchema = z.object({
|
|
1192
1511
|
id: z.string(),
|
|
1193
1512
|
environmentId: z.string(),
|
|
1194
1513
|
auditId: z.string().nullable(),
|
|
1514
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1195
1515
|
createdAt: z.coerce.date(),
|
|
1196
1516
|
updatedAt: z.coerce.date()
|
|
1197
1517
|
});
|
|
1198
1518
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1199
1519
|
platform: z.literal("claudeai"),
|
|
1200
|
-
formData: claudeSubmissionDraftSchema
|
|
1520
|
+
formData: claudeSubmissionDraftSchema,
|
|
1521
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1201
1522
|
});
|
|
1202
1523
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1203
1524
|
platform: z.literal("chatgpt"),
|
|
1204
|
-
formData: chatgptSubmissionDraftSchema
|
|
1525
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1526
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1205
1527
|
});
|
|
1206
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1528
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1207
1529
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1530
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1531
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1532
|
+
z.literal([
|
|
1533
|
+
100,
|
|
1534
|
+
75,
|
|
1535
|
+
50
|
|
1536
|
+
]);
|
|
1208
1537
|
const subscriptionPlanSchema = z.enum([
|
|
1209
1538
|
"pro",
|
|
1210
1539
|
"business",
|
|
@@ -1216,17 +1545,70 @@ const customerCreditsSchema = z.object({
|
|
|
1216
1545
|
expiresAt: z.number().nullable(),
|
|
1217
1546
|
currency: z.string()
|
|
1218
1547
|
});
|
|
1219
|
-
const customerUsageSchema = z.object({
|
|
1220
|
-
amountInCents: z.number(),
|
|
1221
|
-
currency: z.string(),
|
|
1222
|
-
periodEnd: z.number()
|
|
1223
|
-
});
|
|
1224
1548
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1225
1549
|
z.object({
|
|
1226
1550
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1227
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1228
1551
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1229
1552
|
});
|
|
1553
|
+
const metricsQueueEventSchema = z.object({
|
|
1554
|
+
ts: z.number().int(),
|
|
1555
|
+
method: z.string(),
|
|
1556
|
+
tool: z.string().nullable(),
|
|
1557
|
+
client: z.string(),
|
|
1558
|
+
sessionId: z.string().nullable(),
|
|
1559
|
+
durationMs: z.number().int(),
|
|
1560
|
+
outputTokens: z.number().int().nullable(),
|
|
1561
|
+
errorType: z.enum([
|
|
1562
|
+
"mcp_error",
|
|
1563
|
+
"tool_error",
|
|
1564
|
+
"timeout"
|
|
1565
|
+
]).nullable(),
|
|
1566
|
+
errorCode: z.number().int().nullable()
|
|
1567
|
+
});
|
|
1568
|
+
z.object({
|
|
1569
|
+
v: z.literal(1),
|
|
1570
|
+
envId: z.string(),
|
|
1571
|
+
events: z.array(metricsQueueEventSchema)
|
|
1572
|
+
});
|
|
1573
|
+
z.object({ v: z.number() });
|
|
1574
|
+
const telemetrySignalSchema = z.enum([
|
|
1575
|
+
"logs",
|
|
1576
|
+
"metrics",
|
|
1577
|
+
"traces"
|
|
1578
|
+
]);
|
|
1579
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1580
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1581
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1582
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1583
|
+
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");
|
|
1584
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1585
|
+
id: z.string(),
|
|
1586
|
+
name: otlpHeaderNameSchema,
|
|
1587
|
+
value: otlpHeaderValueSchema,
|
|
1588
|
+
isSecret: z.boolean()
|
|
1589
|
+
});
|
|
1590
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1591
|
+
"credentials",
|
|
1592
|
+
"wrong-path",
|
|
1593
|
+
"wrong-protocol",
|
|
1594
|
+
"invalid-payload",
|
|
1595
|
+
"partial-rejection",
|
|
1596
|
+
"blocked-target",
|
|
1597
|
+
"timeout",
|
|
1598
|
+
"unreachable",
|
|
1599
|
+
"receiver-error",
|
|
1600
|
+
"unexpected-status"
|
|
1601
|
+
]);
|
|
1602
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1603
|
+
z.object({
|
|
1604
|
+
id: z.string(),
|
|
1605
|
+
signal: telemetrySignalSchema,
|
|
1606
|
+
endpoint: otlpEndpointSchema,
|
|
1607
|
+
protocol: otlpProtocolSchema,
|
|
1608
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1609
|
+
status: telemetryDestinationStatusSchema,
|
|
1610
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1611
|
+
});
|
|
1230
1612
|
//#endregion
|
|
1231
1613
|
//#region src/auth-scope.ts
|
|
1232
1614
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1269,7 +1651,10 @@ const RESERVED_KEYS = [
|
|
|
1269
1651
|
"BUILD_ARG_START_COMMAND",
|
|
1270
1652
|
"ALPIC_HOST",
|
|
1271
1653
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1272
|
-
"ALPIC_INTENT_META_KEY"
|
|
1654
|
+
"ALPIC_INTENT_META_KEY",
|
|
1655
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1656
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1657
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1273
1658
|
];
|
|
1274
1659
|
const environmentVariableSchema = z.object({
|
|
1275
1660
|
key: z.string().min(2, "Key must be at least 2 characters").regex(/^[a-zA-Z]([a-zA-Z0-9_])+$/, "Key must start with a letter and contain only letters, numbers, and underscores").refine((key) => !RESERVED_KEYS.includes(key), "This key is reserved and cannot be used as an environment variable key"),
|
|
@@ -1322,6 +1707,14 @@ const serverFieldsSchema = z.object({
|
|
|
1322
1707
|
});
|
|
1323
1708
|
//#endregion
|
|
1324
1709
|
//#region src/api.contract.ts
|
|
1710
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1711
|
+
try {
|
|
1712
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1713
|
+
return true;
|
|
1714
|
+
} catch {
|
|
1715
|
+
return false;
|
|
1716
|
+
}
|
|
1717
|
+
};
|
|
1325
1718
|
const deploymentStatusSchema = z.enum([
|
|
1326
1719
|
"ongoing",
|
|
1327
1720
|
"deployed",
|
|
@@ -1350,21 +1743,20 @@ const deploymentSchema = z.object({
|
|
|
1350
1743
|
isCurrent: z.boolean(),
|
|
1351
1744
|
deploymentPageUrl: z.url().nullable()
|
|
1352
1745
|
});
|
|
1353
|
-
const
|
|
1746
|
+
const isValidTimeInput = (value) => {
|
|
1354
1747
|
if (ms(value) !== void 0) return true;
|
|
1355
1748
|
return !Number.isNaN(new Date(value).getTime());
|
|
1356
1749
|
};
|
|
1357
|
-
const
|
|
1750
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1751
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1752
|
+
const createEnvironmentContractV1 = base.route({
|
|
1358
1753
|
path: "/v1/environments",
|
|
1359
1754
|
method: "POST",
|
|
1360
1755
|
summary: "Create an environment",
|
|
1361
1756
|
description: "Create an environment for a project",
|
|
1362
1757
|
tags: ["environments"],
|
|
1363
1758
|
successDescription: "The environment has been created successfully"
|
|
1364
|
-
}).errors({
|
|
1365
|
-
NOT_FOUND: {},
|
|
1366
|
-
BAD_REQUEST: {}
|
|
1367
|
-
}).input(z.object({
|
|
1759
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1368
1760
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1369
1761
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1370
1762
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1377,7 +1769,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1377
1769
|
createdAt: z.coerce.date(),
|
|
1378
1770
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1379
1771
|
}));
|
|
1380
|
-
const getEnvironmentContractV1 =
|
|
1772
|
+
const getEnvironmentContractV1 = base.route({
|
|
1381
1773
|
path: "/v1/environments/{environmentId}",
|
|
1382
1774
|
method: "GET",
|
|
1383
1775
|
summary: "Get an environment",
|
|
@@ -1393,6 +1785,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1393
1785
|
createdAt: z.coerce.date(),
|
|
1394
1786
|
projectId: z.string()
|
|
1395
1787
|
}));
|
|
1788
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1789
|
+
path: "/v1/environments/{environmentId}",
|
|
1790
|
+
method: "DELETE",
|
|
1791
|
+
summary: "Delete an environment",
|
|
1792
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1793
|
+
tags: ["environments"],
|
|
1794
|
+
successDescription: "The environment has been deleted successfully"
|
|
1795
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1396
1796
|
const domainSchema = z.object({
|
|
1397
1797
|
domain: z.string(),
|
|
1398
1798
|
status: z.enum([
|
|
@@ -1434,7 +1834,7 @@ const projectOutputSchema = z.object({
|
|
|
1434
1834
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1435
1835
|
environments: z.array(environmentSchema)
|
|
1436
1836
|
});
|
|
1437
|
-
const getProjectContractV1 =
|
|
1837
|
+
const getProjectContractV1 = base.route({
|
|
1438
1838
|
path: "/v1/projects/{projectId}",
|
|
1439
1839
|
method: "GET",
|
|
1440
1840
|
summary: "Get a project",
|
|
@@ -1442,18 +1842,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1442
1842
|
tags: ["projects"],
|
|
1443
1843
|
successDescription: "The project details"
|
|
1444
1844
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1445
|
-
const listProjectsContractV1 =
|
|
1845
|
+
const listProjectsContractV1 = base.route({
|
|
1446
1846
|
path: "/v1/projects",
|
|
1447
1847
|
method: "GET",
|
|
1448
1848
|
summary: "List projects",
|
|
1449
1849
|
description: "List all projects for a team",
|
|
1450
1850
|
tags: ["projects"],
|
|
1451
1851
|
successDescription: "The list of projects"
|
|
1452
|
-
}).errors({
|
|
1453
|
-
|
|
1454
|
-
BAD_REQUEST: {}
|
|
1455
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1456
|
-
const createProjectContractV1 = oc.route({
|
|
1852
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1853
|
+
const createProjectContractV1 = base.route({
|
|
1457
1854
|
path: "/v1/projects",
|
|
1458
1855
|
method: "POST",
|
|
1459
1856
|
summary: "Create a project",
|
|
@@ -1462,7 +1859,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1462
1859
|
successDescription: "The project has been created successfully"
|
|
1463
1860
|
}).errors({
|
|
1464
1861
|
NOT_FOUND: {},
|
|
1465
|
-
BAD_REQUEST: {},
|
|
1466
1862
|
FORBIDDEN: {}
|
|
1467
1863
|
}).input(z.object({
|
|
1468
1864
|
teamId: z.string().optional(),
|
|
@@ -1503,7 +1899,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1503
1899
|
isSecret: z.boolean(),
|
|
1504
1900
|
createdAt: z.coerce.date()
|
|
1505
1901
|
});
|
|
1506
|
-
const listEnvironmentVariablesContractV1 =
|
|
1902
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1507
1903
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1508
1904
|
method: "GET",
|
|
1509
1905
|
summary: "List environment variables",
|
|
@@ -1511,48 +1907,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1511
1907
|
tags: ["environments"],
|
|
1512
1908
|
successDescription: "The list of environment variables"
|
|
1513
1909
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1514
|
-
const createEnvironmentVariablesContractV1 =
|
|
1910
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1515
1911
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1516
1912
|
method: "POST",
|
|
1517
1913
|
summary: "Add environment variables",
|
|
1518
1914
|
description: "Add one or more environment variables to an environment",
|
|
1519
1915
|
tags: ["environments"],
|
|
1520
1916
|
successDescription: "The environment variables have been added successfully"
|
|
1521
|
-
}).errors({
|
|
1522
|
-
NOT_FOUND: {},
|
|
1523
|
-
BAD_REQUEST: {}
|
|
1524
|
-
}).input(z.object({
|
|
1917
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1525
1918
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1526
1919
|
environmentVariables: environmentVariablesSchema
|
|
1527
1920
|
})).output(z.object({ success: z.literal(true) }));
|
|
1528
|
-
const updateEnvironmentVariableContractV1 =
|
|
1921
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1529
1922
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1530
1923
|
method: "PATCH",
|
|
1531
1924
|
summary: "Update an environment variable",
|
|
1532
1925
|
description: "Update an environment variable by ID",
|
|
1533
1926
|
tags: ["environments"],
|
|
1534
1927
|
successDescription: "The environment variable has been updated successfully"
|
|
1535
|
-
}).errors({
|
|
1536
|
-
NOT_FOUND: {},
|
|
1537
|
-
BAD_REQUEST: {}
|
|
1538
|
-
}).input(z.object({
|
|
1928
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1539
1929
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1540
1930
|
key: environmentVariableSchema.shape.key,
|
|
1541
1931
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1542
1932
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1543
1933
|
})).output(z.object({ success: z.literal(true) }));
|
|
1544
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1934
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1545
1935
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1546
1936
|
method: "DELETE",
|
|
1547
1937
|
summary: "Delete an environment variable",
|
|
1548
1938
|
description: "Delete an environment variable by ID",
|
|
1549
1939
|
tags: ["environments"],
|
|
1550
1940
|
successDescription: "The environment variable has been deleted successfully"
|
|
1551
|
-
}).errors({
|
|
1552
|
-
|
|
1553
|
-
BAD_REQUEST: {}
|
|
1554
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1555
|
-
const deleteProjectContractV1 = oc.route({
|
|
1941
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1942
|
+
const deleteProjectContractV1 = base.route({
|
|
1556
1943
|
path: "/v1/projects/{projectId}",
|
|
1557
1944
|
method: "DELETE",
|
|
1558
1945
|
summary: "Delete a project",
|
|
@@ -1560,7 +1947,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1560
1947
|
tags: ["projects"],
|
|
1561
1948
|
successDescription: "The project has been deleted successfully"
|
|
1562
1949
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1563
|
-
const updateProjectContractV1 =
|
|
1950
|
+
const updateProjectContractV1 = base.route({
|
|
1564
1951
|
path: "/v1/projects/{projectId}",
|
|
1565
1952
|
method: "PATCH",
|
|
1566
1953
|
summary: "Update a project",
|
|
@@ -1569,14 +1956,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1569
1956
|
successDescription: "The project has been updated successfully"
|
|
1570
1957
|
}).errors({
|
|
1571
1958
|
NOT_FOUND: {},
|
|
1572
|
-
BAD_REQUEST: {},
|
|
1573
1959
|
FORBIDDEN: {}
|
|
1574
1960
|
}).input(z.object({
|
|
1575
1961
|
projectId: z.string().describe("The ID of the project"),
|
|
1576
1962
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1577
1963
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1578
1964
|
})).output(projectOutputSchema);
|
|
1579
|
-
const deployEnvironmentContractV1 =
|
|
1965
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1580
1966
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1581
1967
|
method: "POST",
|
|
1582
1968
|
summary: "Deploy an environment",
|
|
@@ -1585,29 +1971,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1585
1971
|
successDescription: "The environment has been deployed successfully"
|
|
1586
1972
|
}).errors({
|
|
1587
1973
|
NOT_FOUND: {},
|
|
1588
|
-
BAD_REQUEST: {},
|
|
1589
1974
|
CONFLICT: {}
|
|
1590
1975
|
}).input(z.object({
|
|
1591
1976
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1592
1977
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1593
1978
|
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.")
|
|
1594
1979
|
})).output(deploymentSchema);
|
|
1595
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1980
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1596
1981
|
path: "/v1/deployments/upload",
|
|
1597
1982
|
method: "POST",
|
|
1598
1983
|
summary: "Upload deployment artifacts",
|
|
1599
1984
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1600
1985
|
tags: ["deployments"],
|
|
1601
1986
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1602
|
-
}).errors({
|
|
1603
|
-
NOT_FOUND: {},
|
|
1604
|
-
BAD_REQUEST: {}
|
|
1605
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1987
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1606
1988
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1607
1989
|
token: z.string().describe("Token to identify the source archive"),
|
|
1608
1990
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1609
1991
|
}));
|
|
1610
|
-
const listDeploymentsContractV1 =
|
|
1992
|
+
const listDeploymentsContractV1 = base.route({
|
|
1611
1993
|
path: "/v1/projects/{projectId}/deployments",
|
|
1612
1994
|
method: "GET",
|
|
1613
1995
|
summary: "List project deployments",
|
|
@@ -1619,7 +2001,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1619
2001
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1620
2002
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1621
2003
|
})).output(z.array(deploymentSchema));
|
|
1622
|
-
const getDeploymentContractV1 =
|
|
2004
|
+
const getDeploymentContractV1 = base.route({
|
|
1623
2005
|
path: "/v1/deployments/{deploymentId}",
|
|
1624
2006
|
method: "GET",
|
|
1625
2007
|
summary: "Get a deployment",
|
|
@@ -1642,20 +2024,17 @@ const logEntrySchema = z.object({
|
|
|
1642
2024
|
method: z.string().optional(),
|
|
1643
2025
|
durationInMs: z.number().optional()
|
|
1644
2026
|
});
|
|
1645
|
-
const getLogsContractV1 =
|
|
2027
|
+
const getLogsContractV1 = base.route({
|
|
1646
2028
|
path: "/v1/environments/{environmentId}/logs",
|
|
1647
2029
|
method: "GET",
|
|
1648
2030
|
summary: "Get logs",
|
|
1649
2031
|
description: "Get logs for an environment",
|
|
1650
2032
|
tags: ["environments"],
|
|
1651
2033
|
successDescription: "The logs"
|
|
1652
|
-
}).errors({
|
|
1653
|
-
NOT_FOUND: {},
|
|
1654
|
-
BAD_REQUEST: {}
|
|
1655
|
-
}).input(z.object({
|
|
2034
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1656
2035
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1657
|
-
since:
|
|
1658
|
-
until:
|
|
2036
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2037
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1659
2038
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1660
2039
|
level: z.array(z.enum([
|
|
1661
2040
|
"INFO",
|
|
@@ -1663,23 +2042,20 @@ const getLogsContractV1 = oc.route({
|
|
|
1663
2042
|
"WARNING",
|
|
1664
2043
|
"DEBUG"
|
|
1665
2044
|
])).optional().describe("Filter by log level"),
|
|
1666
|
-
search:
|
|
2045
|
+
search: logSearchSchema.optional().describe("Term to search for in log content"),
|
|
1667
2046
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1668
2047
|
})).output(z.object({
|
|
1669
2048
|
logs: z.array(logEntrySchema),
|
|
1670
2049
|
nextToken: z.string().nullable()
|
|
1671
2050
|
}));
|
|
1672
|
-
const getLatestLogsContractV1 =
|
|
2051
|
+
const getLatestLogsContractV1 = base.route({
|
|
1673
2052
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1674
2053
|
method: "GET",
|
|
1675
2054
|
summary: "Get latest logs",
|
|
1676
2055
|
description: "Get the N most recent logs for an environment",
|
|
1677
2056
|
tags: ["environments"],
|
|
1678
2057
|
successDescription: "The latest logs"
|
|
1679
|
-
}).errors({
|
|
1680
|
-
NOT_FOUND: {},
|
|
1681
|
-
BAD_REQUEST: {}
|
|
1682
|
-
}).input(z.object({
|
|
2058
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1683
2059
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1684
2060
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1685
2061
|
level: z.array(z.enum([
|
|
@@ -1688,9 +2064,9 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1688
2064
|
"WARNING",
|
|
1689
2065
|
"DEBUG"
|
|
1690
2066
|
])).optional().describe("Filter by log level"),
|
|
1691
|
-
search:
|
|
2067
|
+
search: logSearchSchema.optional().describe("Term to search for in log content")
|
|
1692
2068
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1693
|
-
const getDeploymentLogsContractV1 =
|
|
2069
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1694
2070
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1695
2071
|
method: "GET",
|
|
1696
2072
|
summary: "Get deployment logs",
|
|
@@ -1717,22 +2093,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1717
2093
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1718
2094
|
task_count: z.array(analyticsDataPointSchema)
|
|
1719
2095
|
});
|
|
1720
|
-
const getProjectAnalyticsContractV1 =
|
|
2096
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1721
2097
|
path: "/v1/analytics/{projectId}",
|
|
1722
2098
|
method: "GET",
|
|
1723
2099
|
summary: "Get project analytics",
|
|
1724
2100
|
description: "Get analytics data for a project over a time range",
|
|
1725
2101
|
tags: ["analytics"],
|
|
1726
2102
|
successDescription: "The project analytics data"
|
|
1727
|
-
}).errors({
|
|
1728
|
-
NOT_FOUND: {},
|
|
1729
|
-
BAD_REQUEST: {}
|
|
1730
|
-
}).input(z.object({
|
|
2103
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1731
2104
|
projectId: z.string().describe("The ID of the project"),
|
|
1732
2105
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1733
2106
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1734
2107
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1735
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2108
|
+
}).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({
|
|
1736
2109
|
metadata: z.object({
|
|
1737
2110
|
startTimestamp: z.number(),
|
|
1738
2111
|
endTimestamp: z.number(),
|
|
@@ -1742,7 +2115,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1742
2115
|
}),
|
|
1743
2116
|
timeSeries: analyticsTimeSeriesSchema
|
|
1744
2117
|
}));
|
|
1745
|
-
const
|
|
2118
|
+
const paginatedInsightsInputShape = {
|
|
2119
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2120
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2121
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2122
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2123
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2124
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2125
|
+
};
|
|
2126
|
+
const listIntentsContractV1 = base.route({
|
|
2127
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2128
|
+
method: "GET",
|
|
2129
|
+
summary: "List intents",
|
|
2130
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2131
|
+
tags: ["insights"],
|
|
2132
|
+
successDescription: "The grouped user intents"
|
|
2133
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2134
|
+
...paginatedInsightsInputShape,
|
|
2135
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2136
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2137
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2138
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2139
|
+
})).output(z.object({
|
|
2140
|
+
intents: z.array(z.object({
|
|
2141
|
+
id: z.string(),
|
|
2142
|
+
intentIds: z.array(z.string()).min(1),
|
|
2143
|
+
environmentId: z.string(),
|
|
2144
|
+
message: z.string(),
|
|
2145
|
+
toolName: z.string(),
|
|
2146
|
+
createdAt: z.coerce.date(),
|
|
2147
|
+
occurrenceCount: z.number().int().positive(),
|
|
2148
|
+
clientName: z.string().nullable(),
|
|
2149
|
+
clientId: z.string().nullable(),
|
|
2150
|
+
categories: z.array(z.object({
|
|
2151
|
+
id: z.string(),
|
|
2152
|
+
name: z.string(),
|
|
2153
|
+
color: intentCategoryColorSchema
|
|
2154
|
+
}))
|
|
2155
|
+
})),
|
|
2156
|
+
totalCount: z.number().int().nonnegative()
|
|
2157
|
+
}));
|
|
2158
|
+
const listFeedbacksContractV1 = base.route({
|
|
2159
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2160
|
+
method: "GET",
|
|
2161
|
+
summary: "List feedbacks",
|
|
2162
|
+
description: "List user feedback for an environment over a time range",
|
|
2163
|
+
tags: ["insights"],
|
|
2164
|
+
successDescription: "The user feedback"
|
|
2165
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2166
|
+
...paginatedInsightsInputShape,
|
|
2167
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2168
|
+
})).output(z.object({
|
|
2169
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2170
|
+
totalCount: z.number().int().nonnegative()
|
|
2171
|
+
}));
|
|
2172
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2173
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2174
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2175
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2176
|
+
method: "GET",
|
|
2177
|
+
summary: "List intent categories",
|
|
2178
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2179
|
+
tags: ["insights"],
|
|
2180
|
+
successDescription: "The intent categories"
|
|
2181
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2182
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2183
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2184
|
+
method: "POST",
|
|
2185
|
+
summary: "Create an intent category",
|
|
2186
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2187
|
+
tags: ["insights"],
|
|
2188
|
+
successDescription: "The created intent category"
|
|
2189
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2190
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2191
|
+
name: intentCategoryNameSchema,
|
|
2192
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2193
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2194
|
+
})).output(intentCategorySchema);
|
|
2195
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2196
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2197
|
+
method: "PATCH",
|
|
2198
|
+
summary: "Update an intent category",
|
|
2199
|
+
description: "Rename or recolor an intent category",
|
|
2200
|
+
tags: ["insights"],
|
|
2201
|
+
successDescription: "The updated intent category"
|
|
2202
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2203
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2204
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2205
|
+
name: intentCategoryNameSchema.optional(),
|
|
2206
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2207
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2208
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2209
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2210
|
+
method: "DELETE",
|
|
2211
|
+
summary: "Delete an intent category",
|
|
2212
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2213
|
+
tags: ["insights"],
|
|
2214
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2215
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2216
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2217
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2218
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2219
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2220
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2221
|
+
method: "POST",
|
|
2222
|
+
summary: "Link an intent category",
|
|
2223
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2224
|
+
tags: ["insights"],
|
|
2225
|
+
successDescription: "The intents have been linked successfully"
|
|
2226
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2227
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2228
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2229
|
+
intentIds: categorizableIntentIdsSchema
|
|
2230
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2231
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2232
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2233
|
+
method: "POST",
|
|
2234
|
+
summary: "Unlink an intent category",
|
|
2235
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2236
|
+
tags: ["insights"],
|
|
2237
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2238
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2239
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2240
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2241
|
+
intentIds: categorizableIntentIdsSchema
|
|
2242
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2243
|
+
const listTeamsContractV1 = base.route({
|
|
1746
2244
|
path: "/v1/teams",
|
|
1747
2245
|
method: "GET",
|
|
1748
2246
|
summary: "List teams",
|
|
@@ -1755,7 +2253,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1755
2253
|
createdAt: z.coerce.date(),
|
|
1756
2254
|
hasStripeAccount: z.boolean()
|
|
1757
2255
|
})));
|
|
1758
|
-
const
|
|
2256
|
+
const getTeamUsageContractV1 = base.route({
|
|
2257
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2258
|
+
method: "GET",
|
|
2259
|
+
summary: "Get team usage",
|
|
2260
|
+
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.",
|
|
2261
|
+
tags: ["teams"],
|
|
2262
|
+
successDescription: "The current billing window usage"
|
|
2263
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2264
|
+
teamId: z.string(),
|
|
2265
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2266
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2267
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2268
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2269
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2270
|
+
}));
|
|
2271
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1759
2272
|
path: "/v1/tunnels/ticket",
|
|
1760
2273
|
method: "GET",
|
|
1761
2274
|
summary: "Get a tunnel ticket",
|
|
@@ -1767,16 +2280,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1767
2280
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1768
2281
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1769
2282
|
}));
|
|
1770
|
-
const publishServerContractV1 =
|
|
2283
|
+
const publishServerContractV1 = base.route({
|
|
1771
2284
|
path: "/v1/distribution/publish",
|
|
1772
2285
|
method: "POST",
|
|
1773
2286
|
summary: "Publish a server to the MCP registry",
|
|
1774
2287
|
tags: ["distribution"],
|
|
1775
2288
|
successDescription: "The server has been published successfully"
|
|
1776
|
-
}).errors({
|
|
1777
|
-
NOT_FOUND: {},
|
|
1778
|
-
BAD_REQUEST: {}
|
|
1779
|
-
}).input(z.object({
|
|
2289
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1780
2290
|
projectId: z.string(),
|
|
1781
2291
|
domain: z.string(),
|
|
1782
2292
|
title: z.string().min(1).max(100),
|
|
@@ -1785,17 +2295,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1785
2295
|
iconSrc: z.url().max(255).optional(),
|
|
1786
2296
|
dryRun: z.boolean().optional()
|
|
1787
2297
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1788
|
-
const getServerInfoContractV1 =
|
|
2298
|
+
const getServerInfoContractV1 = base.route({
|
|
1789
2299
|
path: "/v1/distribution/get",
|
|
1790
2300
|
method: "GET",
|
|
1791
2301
|
summary: "Get server info",
|
|
1792
2302
|
description: "Get info about a server",
|
|
1793
2303
|
tags: ["distribution"],
|
|
1794
2304
|
successDescription: "The server info"
|
|
1795
|
-
}).errors({
|
|
1796
|
-
NOT_FOUND: {},
|
|
1797
|
-
BAD_REQUEST: {}
|
|
1798
|
-
}).input(z.object({
|
|
2305
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1799
2306
|
projectId: z.string(),
|
|
1800
2307
|
domain: z.string()
|
|
1801
2308
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1814,7 +2321,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1814
2321
|
isPlaygroundEnabled: z.boolean(),
|
|
1815
2322
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1816
2323
|
});
|
|
1817
|
-
const getPlaygroundContractV1 =
|
|
2324
|
+
const getPlaygroundContractV1 = base.route({
|
|
1818
2325
|
path: "/v1/environments/{environmentId}/playground",
|
|
1819
2326
|
method: "GET",
|
|
1820
2327
|
summary: "Get playground configuration",
|
|
@@ -1822,17 +2329,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1822
2329
|
tags: ["environments"],
|
|
1823
2330
|
successDescription: "The playground configuration"
|
|
1824
2331
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1825
|
-
const upsertPlaygroundContractV1 =
|
|
2332
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1826
2333
|
path: "/v1/environments/{environmentId}/playground",
|
|
1827
2334
|
method: "PUT",
|
|
1828
2335
|
summary: "Update playground configuration",
|
|
1829
2336
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1830
2337
|
tags: ["environments"],
|
|
1831
2338
|
successDescription: "The updated playground configuration"
|
|
1832
|
-
}).errors({
|
|
1833
|
-
NOT_FOUND: {},
|
|
1834
|
-
BAD_REQUEST: {}
|
|
1835
|
-
}).input(z.object({
|
|
2339
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1836
2340
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1837
2341
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1838
2342
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1840,7 +2344,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1840
2344
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1841
2345
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1842
2346
|
})).output(playgroundOutputSchema);
|
|
1843
|
-
const createBeaconContractV1 =
|
|
2347
|
+
const createBeaconContractV1 = base.route({
|
|
1844
2348
|
path: "/v1/beacon/audits",
|
|
1845
2349
|
method: "POST",
|
|
1846
2350
|
summary: "Create a beacon audit",
|
|
@@ -1849,7 +2353,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1849
2353
|
successDescription: "The audit has been created"
|
|
1850
2354
|
}).errors({
|
|
1851
2355
|
NOT_FOUND: {},
|
|
1852
|
-
BAD_REQUEST: {},
|
|
1853
2356
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1854
2357
|
}).input(z.object({
|
|
1855
2358
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1857,7 +2360,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1857
2360
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1858
2361
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1859
2362
|
})).output(z.object({ id: z.string() }));
|
|
1860
|
-
const getBeaconContractV1 =
|
|
2363
|
+
const getBeaconContractV1 = base.route({
|
|
1861
2364
|
path: "/v1/beacon/audits/{auditId}",
|
|
1862
2365
|
method: "GET",
|
|
1863
2366
|
summary: "Get a beacon audit",
|
|
@@ -1872,9 +2375,73 @@ const getBeaconContractV1 = oc.route({
|
|
|
1872
2375
|
createdAt: z.coerce.date(),
|
|
1873
2376
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1874
2377
|
}));
|
|
2378
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2379
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2380
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2381
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2382
|
+
const createSubmissionContractV1 = base.route({
|
|
2383
|
+
path: "/v1/submissions",
|
|
2384
|
+
method: "POST",
|
|
2385
|
+
summary: "Create a submission package",
|
|
2386
|
+
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.",
|
|
2387
|
+
tags: ["submissions"],
|
|
2388
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2389
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2390
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2391
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2392
|
+
})).output(submissionSchema);
|
|
2393
|
+
const listSubmissionsContractV1 = base.route({
|
|
2394
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2395
|
+
method: "GET",
|
|
2396
|
+
summary: "List submission packages",
|
|
2397
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2398
|
+
tags: ["submissions"],
|
|
2399
|
+
successDescription: "The list of submission packages"
|
|
2400
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2401
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2402
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2403
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2404
|
+
})).output(z.array(submissionSchema));
|
|
2405
|
+
const getSubmissionContractV1 = base.route({
|
|
2406
|
+
path: "/v1/submissions/{submissionId}",
|
|
2407
|
+
method: "GET",
|
|
2408
|
+
summary: "Get a submission package",
|
|
2409
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2410
|
+
tags: ["submissions"],
|
|
2411
|
+
successDescription: "The submission package"
|
|
2412
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2413
|
+
const updateSubmissionContractV1 = base.route({
|
|
2414
|
+
path: "/v1/submissions/{submissionId}",
|
|
2415
|
+
method: "PUT",
|
|
2416
|
+
summary: "Update a submission package",
|
|
2417
|
+
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.",
|
|
2418
|
+
tags: ["submissions"],
|
|
2419
|
+
successDescription: "The updated submission package"
|
|
2420
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2421
|
+
submissionId: submissionIdSchema,
|
|
2422
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2423
|
+
formData: claudeSubmissionUpdateSchema
|
|
2424
|
+
}), z.object({
|
|
2425
|
+
submissionId: submissionIdSchema,
|
|
2426
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2427
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2428
|
+
})])).output(submissionSchema);
|
|
1875
2429
|
const contract = {
|
|
1876
|
-
teams: {
|
|
2430
|
+
teams: {
|
|
2431
|
+
list: { v1: listTeamsContractV1 },
|
|
2432
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2433
|
+
},
|
|
1877
2434
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2435
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2436
|
+
intentCategories: {
|
|
2437
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2438
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2439
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2440
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2441
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2442
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2443
|
+
},
|
|
2444
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1878
2445
|
deployments: {
|
|
1879
2446
|
list: { v1: listDeploymentsContractV1 },
|
|
1880
2447
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1884,6 +2451,7 @@ const contract = {
|
|
|
1884
2451
|
environments: {
|
|
1885
2452
|
create: { v1: createEnvironmentContractV1 },
|
|
1886
2453
|
get: { v1: getEnvironmentContractV1 },
|
|
2454
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1887
2455
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1888
2456
|
getLogs: { v1: getLogsContractV1 },
|
|
1889
2457
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1913,7 +2481,39 @@ const contract = {
|
|
|
1913
2481
|
beacon: {
|
|
1914
2482
|
create: { v1: createBeaconContractV1 },
|
|
1915
2483
|
get: { v1: getBeaconContractV1 }
|
|
2484
|
+
},
|
|
2485
|
+
submissions: {
|
|
2486
|
+
create: { v1: createSubmissionContractV1 },
|
|
2487
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2488
|
+
get: { v1: getSubmissionContractV1 },
|
|
2489
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2490
|
+
}
|
|
2491
|
+
};
|
|
2492
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2493
|
+
const contractForDocs = {
|
|
2494
|
+
...contract,
|
|
2495
|
+
deployments: deploymentsForDocs
|
|
2496
|
+
};
|
|
2497
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2498
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2499
|
+
info: {
|
|
2500
|
+
title: "Alpic API",
|
|
2501
|
+
version: "1.0.0"
|
|
2502
|
+
},
|
|
2503
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2504
|
+
security: [{ bearerAuth: [] }],
|
|
2505
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2506
|
+
type: "http",
|
|
2507
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2508
|
+
scheme: "bearer"
|
|
2509
|
+
} } },
|
|
2510
|
+
commonSchemas: {
|
|
2511
|
+
Submission: { schema: submissionSchema },
|
|
2512
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2513
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2514
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2515
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
1916
2516
|
}
|
|
1917
2517
|
};
|
|
1918
2518
|
//#endregion
|
|
1919
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2519
|
+
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 };
|