@alpic-ai/api 0.0.0-dev.ge9cb8ec → 0.0.0-dev.gea4a8f4
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 +787 -185
- 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.32.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
|
*/
|
|
@@ -119,7 +119,12 @@ z$1.object({
|
|
|
119
119
|
token_type: z$1.string(),
|
|
120
120
|
expires_in: z$1.coerce.number().optional(),
|
|
121
121
|
scope: z$1.string().optional(),
|
|
122
|
-
refresh_token: z$1.string().optional()
|
|
122
|
+
refresh_token: z$1.string().optional(),
|
|
123
|
+
/**
|
|
124
|
+
* Not part of the wire format: the authorization server this value was obtained from, added by
|
|
125
|
+
* the client's `auth()` before it is stored and compared when it is read back.
|
|
126
|
+
*/
|
|
127
|
+
issuer: z$1.string().optional().catch(void 0)
|
|
123
128
|
}).strip();
|
|
124
129
|
z$1.object({
|
|
125
130
|
error: z$1.string(),
|
|
@@ -158,7 +163,12 @@ const OAuthClientInformationSchema = z$1.object({
|
|
|
158
163
|
client_id: z$1.string(),
|
|
159
164
|
client_secret: z$1.string().optional(),
|
|
160
165
|
client_id_issued_at: z$1.number().optional(),
|
|
161
|
-
client_secret_expires_at: z$1.number().optional()
|
|
166
|
+
client_secret_expires_at: z$1.number().optional(),
|
|
167
|
+
/**
|
|
168
|
+
* Not part of the wire format: the authorization server this value was obtained from, added by
|
|
169
|
+
* the client's `auth()` before it is stored and compared when it is read back.
|
|
170
|
+
*/
|
|
171
|
+
issuer: z$1.string().optional().catch(void 0)
|
|
162
172
|
}).strip();
|
|
163
173
|
OAuthClientMetadataSchema.merge(OAuthClientInformationSchema);
|
|
164
174
|
z$1.object({
|
|
@@ -179,6 +189,7 @@ const PLATFORM_LABELS = {
|
|
|
179
189
|
};
|
|
180
190
|
const WAF_PLATFORMS = [
|
|
181
191
|
"akamai",
|
|
192
|
+
"cato",
|
|
182
193
|
"cloudflare",
|
|
183
194
|
"fastly"
|
|
184
195
|
];
|
|
@@ -256,6 +267,25 @@ z.object({
|
|
|
256
267
|
clientSecret: z.string(),
|
|
257
268
|
clientScopes: z.array(z.string())
|
|
258
269
|
});
|
|
270
|
+
const creditEntryReasonSchema = z.enum([
|
|
271
|
+
"free_seed",
|
|
272
|
+
"paid_conversion_floor",
|
|
273
|
+
"top_up",
|
|
274
|
+
"usage",
|
|
275
|
+
"admin_adjustment"
|
|
276
|
+
]);
|
|
277
|
+
z.enum(["playground"]);
|
|
278
|
+
z.number().int().min(500);
|
|
279
|
+
const creditActivityEntrySchema = z.object({
|
|
280
|
+
reason: creditEntryReasonSchema,
|
|
281
|
+
day: z.number(),
|
|
282
|
+
amountInNanoUSD: z.number(),
|
|
283
|
+
messageCount: z.number().nullable()
|
|
284
|
+
});
|
|
285
|
+
z.object({
|
|
286
|
+
balanceInNanoUSD: z.number(),
|
|
287
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
288
|
+
});
|
|
259
289
|
const deploymentStatusSchema$1 = z.enum([
|
|
260
290
|
"ongoing",
|
|
261
291
|
"deployed",
|
|
@@ -283,33 +313,18 @@ const deploymentSummarySchema = z.object({
|
|
|
283
313
|
createdAt: z.coerce.date(),
|
|
284
314
|
updatedAt: z.coerce.date()
|
|
285
315
|
});
|
|
286
|
-
/**
|
|
287
|
-
* Public environment
|
|
288
|
-
*
|
|
289
|
-
* Answers anonymously and exposes no OAuth metadata.
|
|
290
|
-
*/
|
|
316
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
291
317
|
const publicEnvironmentSchema = z.object({
|
|
292
318
|
allowsAnonymous: z.literal(true),
|
|
293
319
|
oAuthMetadata: z.strictObject({})
|
|
294
320
|
});
|
|
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
|
-
*/
|
|
321
|
+
/** 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
322
|
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
302
323
|
allowsAnonymous: z.boolean(),
|
|
303
324
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
304
325
|
scope: z.string().optional()
|
|
305
326
|
});
|
|
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
|
-
*/
|
|
327
|
+
/** 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
328
|
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
314
329
|
allowsAnonymous: z.boolean(),
|
|
315
330
|
oAuthMetadata: z.object({
|
|
@@ -318,12 +333,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
318
333
|
}),
|
|
319
334
|
scope: z.string().optional()
|
|
320
335
|
});
|
|
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
|
-
*/
|
|
336
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
327
337
|
const standaloneEnvironmentSchema = z.object({
|
|
328
338
|
allowsAnonymous: z.boolean(),
|
|
329
339
|
oAuthMetadata: z.object({
|
|
@@ -332,13 +342,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
332
342
|
}),
|
|
333
343
|
scope: z.string().optional()
|
|
334
344
|
});
|
|
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
|
-
*/
|
|
345
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
342
346
|
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
343
347
|
allowsAnonymous: z.literal(false),
|
|
344
348
|
oAuthMetadata: z.strictObject({}),
|
|
@@ -426,14 +430,16 @@ z.object({
|
|
|
426
430
|
collectResponsePayload: z.boolean(),
|
|
427
431
|
collectErrorMessage: z.boolean(),
|
|
428
432
|
collectUserData: z.boolean(),
|
|
429
|
-
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
433
|
+
identityTraitKey: z.string().min(1).max(200).nullable(),
|
|
434
|
+
leadEventName: z.string().min(1).max(200).nullable()
|
|
430
435
|
});
|
|
431
|
-
z.object({
|
|
436
|
+
const feedbackSchema = z.object({
|
|
432
437
|
id: z.string(),
|
|
433
438
|
createdAt: z.coerce.date(),
|
|
434
439
|
environmentId: z.string(),
|
|
435
440
|
content: z.string(),
|
|
436
|
-
source: z.enum(["model", "user"])
|
|
441
|
+
source: z.enum(["model", "user"]),
|
|
442
|
+
clientName: z.string().nullable()
|
|
437
443
|
});
|
|
438
444
|
z.object({
|
|
439
445
|
content: z.string(),
|
|
@@ -449,7 +455,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
449
455
|
"pink",
|
|
450
456
|
"gray"
|
|
451
457
|
]);
|
|
452
|
-
intentCategoryColorSchema.options;
|
|
458
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
453
459
|
const intentCategorySchema = z.object({
|
|
454
460
|
id: z.string(),
|
|
455
461
|
createdAt: z.coerce.date(),
|
|
@@ -457,7 +463,7 @@ const intentCategorySchema = z.object({
|
|
|
457
463
|
name: z.string(),
|
|
458
464
|
color: intentCategoryColorSchema
|
|
459
465
|
});
|
|
460
|
-
z.object({
|
|
466
|
+
const intentCategorySummarySchema = z.object({
|
|
461
467
|
id: z.string(),
|
|
462
468
|
name: z.string(),
|
|
463
469
|
color: intentCategoryColorSchema,
|
|
@@ -469,6 +475,7 @@ z.object({
|
|
|
469
475
|
environmentId: z.string(),
|
|
470
476
|
toolName: z.string(),
|
|
471
477
|
message: z.string(),
|
|
478
|
+
clientName: z.string().nullable(),
|
|
472
479
|
categories: z.array(intentCategorySchema)
|
|
473
480
|
});
|
|
474
481
|
const signalCategorySchema = z.object({
|
|
@@ -527,12 +534,270 @@ z.object({
|
|
|
527
534
|
createdAt: z.coerce.date(),
|
|
528
535
|
updatedAt: z.coerce.date()
|
|
529
536
|
});
|
|
537
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
538
|
+
type: z.literal("mcp_request"),
|
|
539
|
+
method: z.string()
|
|
540
|
+
});
|
|
541
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
542
|
+
type: z.literal("mcp_error"),
|
|
543
|
+
method: z.string(),
|
|
544
|
+
error: z.string()
|
|
545
|
+
});
|
|
546
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
530
547
|
z.enum([
|
|
531
548
|
"INFO",
|
|
532
549
|
"WARNING",
|
|
533
550
|
"DEBUG",
|
|
534
551
|
"ERROR"
|
|
535
552
|
]);
|
|
553
|
+
const LOG_SEARCH_MAX_ESCAPED_LENGTH = 960;
|
|
554
|
+
function escapeLogSearchTerm(search) {
|
|
555
|
+
return [...search].flatMap((character) => [...new TextEncoder().encode(character)]).map((byte) => {
|
|
556
|
+
const character = String.fromCharCode(byte);
|
|
557
|
+
return /^[a-zA-Z0-9]$/.test(character) ? character : `\\x${byte.toString(16).toUpperCase().padStart(2, "0")}`;
|
|
558
|
+
}).join("");
|
|
559
|
+
}
|
|
560
|
+
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");
|
|
561
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
562
|
+
const MCP_CLIENT_GROUPS = [
|
|
563
|
+
{
|
|
564
|
+
id: "claude_code",
|
|
565
|
+
label: "Claude Code",
|
|
566
|
+
vendor: "anthropic",
|
|
567
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
id: "claude",
|
|
571
|
+
label: "Claude",
|
|
572
|
+
vendor: "anthropic",
|
|
573
|
+
rawNames: [
|
|
574
|
+
"Anthropic/ClaudeAI",
|
|
575
|
+
"claude-ai",
|
|
576
|
+
"claude",
|
|
577
|
+
"Claude",
|
|
578
|
+
"claude-desktop",
|
|
579
|
+
"claude-desktop-3p"
|
|
580
|
+
]
|
|
581
|
+
},
|
|
582
|
+
{
|
|
583
|
+
id: "claude_mobile",
|
|
584
|
+
label: "Claude mobile",
|
|
585
|
+
vendor: "anthropic",
|
|
586
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
587
|
+
},
|
|
588
|
+
{
|
|
589
|
+
id: "claude_cowork",
|
|
590
|
+
label: "Claude Cowork",
|
|
591
|
+
vendor: "anthropic",
|
|
592
|
+
rawNames: ["Anthropic/Cowork"]
|
|
593
|
+
},
|
|
594
|
+
{
|
|
595
|
+
id: "claude_toolbox",
|
|
596
|
+
label: "Claude Toolbox",
|
|
597
|
+
vendor: "anthropic",
|
|
598
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
599
|
+
},
|
|
600
|
+
{
|
|
601
|
+
id: "anthropic_api",
|
|
602
|
+
label: "Anthropic API",
|
|
603
|
+
vendor: "anthropic",
|
|
604
|
+
rawNames: ["Anthropic/API"]
|
|
605
|
+
},
|
|
606
|
+
{
|
|
607
|
+
id: "anthropic_connector_refresh",
|
|
608
|
+
label: "Anthropic (connector refresh)",
|
|
609
|
+
vendor: "anthropic",
|
|
610
|
+
rawNames: ["Anthropic"]
|
|
611
|
+
},
|
|
612
|
+
{
|
|
613
|
+
id: "codex",
|
|
614
|
+
label: "Codex",
|
|
615
|
+
vendor: "openai",
|
|
616
|
+
rawNames: [
|
|
617
|
+
"codex-mcp-client",
|
|
618
|
+
"codex",
|
|
619
|
+
"Codex",
|
|
620
|
+
"codex-cli",
|
|
621
|
+
"openai-mcp (Codex)"
|
|
622
|
+
]
|
|
623
|
+
},
|
|
624
|
+
{
|
|
625
|
+
id: "chatgpt",
|
|
626
|
+
label: "ChatGPT",
|
|
627
|
+
vendor: "openai",
|
|
628
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
629
|
+
},
|
|
630
|
+
{
|
|
631
|
+
id: "openai_responses_api",
|
|
632
|
+
label: "OpenAI Responses API",
|
|
633
|
+
vendor: "openai",
|
|
634
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
635
|
+
},
|
|
636
|
+
{
|
|
637
|
+
id: "openai_agent_builder",
|
|
638
|
+
label: "OpenAI Agent Builder",
|
|
639
|
+
vendor: "openai",
|
|
640
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
641
|
+
},
|
|
642
|
+
{
|
|
643
|
+
id: "openai_other",
|
|
644
|
+
label: "OpenAI Other",
|
|
645
|
+
vendor: "openai",
|
|
646
|
+
rawNames: ["openai-mcp"]
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
id: "cursor",
|
|
650
|
+
label: "Cursor",
|
|
651
|
+
vendor: "cursor",
|
|
652
|
+
rawNames: [
|
|
653
|
+
"cursor-vscode",
|
|
654
|
+
"Cursor",
|
|
655
|
+
"cursor"
|
|
656
|
+
]
|
|
657
|
+
},
|
|
658
|
+
{
|
|
659
|
+
id: "cline",
|
|
660
|
+
label: "Cline",
|
|
661
|
+
vendor: "cline",
|
|
662
|
+
rawNames: [
|
|
663
|
+
"Cline",
|
|
664
|
+
"cline",
|
|
665
|
+
"@cline/core"
|
|
666
|
+
]
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
id: "github_copilot",
|
|
670
|
+
label: "GitHub Copilot",
|
|
671
|
+
vendor: "githubCopilot",
|
|
672
|
+
rawNames: [
|
|
673
|
+
"Copilot",
|
|
674
|
+
"github-copilot-developer",
|
|
675
|
+
"Copilot MCP Gateway",
|
|
676
|
+
"Xcode/copilot-xcode"
|
|
677
|
+
]
|
|
678
|
+
},
|
|
679
|
+
{
|
|
680
|
+
id: "gemini_cli",
|
|
681
|
+
label: "Gemini CLI",
|
|
682
|
+
vendor: "google",
|
|
683
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
684
|
+
},
|
|
685
|
+
{
|
|
686
|
+
id: "antigravity",
|
|
687
|
+
label: "Antigravity",
|
|
688
|
+
vendor: "google",
|
|
689
|
+
rawNames: ["antigravity-client"]
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
id: "gemini",
|
|
693
|
+
label: "Gemini",
|
|
694
|
+
vendor: "google",
|
|
695
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
696
|
+
},
|
|
697
|
+
{
|
|
698
|
+
id: "windsurf",
|
|
699
|
+
label: "Windsurf",
|
|
700
|
+
vendor: "windsurf",
|
|
701
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
702
|
+
},
|
|
703
|
+
{
|
|
704
|
+
id: "mistral",
|
|
705
|
+
label: "Mistral / Le Chat",
|
|
706
|
+
vendor: "mistral",
|
|
707
|
+
rawNames: ["Mistral"],
|
|
708
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
709
|
+
},
|
|
710
|
+
{
|
|
711
|
+
id: "n8n",
|
|
712
|
+
label: "n8n",
|
|
713
|
+
vendor: "n8n",
|
|
714
|
+
rawNames: [
|
|
715
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
716
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
717
|
+
"n8n"
|
|
718
|
+
]
|
|
719
|
+
},
|
|
720
|
+
{
|
|
721
|
+
id: "alpic_playground",
|
|
722
|
+
label: "Alpic Playground",
|
|
723
|
+
vendor: "alpic",
|
|
724
|
+
rawNames: ["alpic-playground", "playground"]
|
|
725
|
+
},
|
|
726
|
+
{
|
|
727
|
+
id: "opencode",
|
|
728
|
+
label: "opencode",
|
|
729
|
+
vendor: "opencode",
|
|
730
|
+
rawNames: ["opencode"]
|
|
731
|
+
},
|
|
732
|
+
{
|
|
733
|
+
id: "zed",
|
|
734
|
+
label: "Zed",
|
|
735
|
+
vendor: "zed",
|
|
736
|
+
rawNames: ["Zed", "zed"]
|
|
737
|
+
},
|
|
738
|
+
{
|
|
739
|
+
id: "zapier",
|
|
740
|
+
label: "Zapier",
|
|
741
|
+
vendor: "zapier",
|
|
742
|
+
rawNames: ["Zapier", "zapier"]
|
|
743
|
+
},
|
|
744
|
+
{
|
|
745
|
+
id: "make",
|
|
746
|
+
label: "Make",
|
|
747
|
+
vendor: "make",
|
|
748
|
+
rawNames: ["Make", "make"]
|
|
749
|
+
},
|
|
750
|
+
{
|
|
751
|
+
id: "librechat",
|
|
752
|
+
label: "LibreChat",
|
|
753
|
+
vendor: "mcp",
|
|
754
|
+
rawNames: ["LibreChat", "librechat"]
|
|
755
|
+
},
|
|
756
|
+
{
|
|
757
|
+
id: "jan",
|
|
758
|
+
label: "Jan",
|
|
759
|
+
vendor: "mcp",
|
|
760
|
+
rawNames: ["Jan", "jan"]
|
|
761
|
+
},
|
|
762
|
+
{
|
|
763
|
+
id: "goose",
|
|
764
|
+
label: "goose",
|
|
765
|
+
vendor: "mcp",
|
|
766
|
+
rawNames: ["goose", "Goose"]
|
|
767
|
+
},
|
|
768
|
+
{
|
|
769
|
+
id: "mcphost",
|
|
770
|
+
label: "mcphost",
|
|
771
|
+
vendor: "mcp",
|
|
772
|
+
rawNames: ["mcphost"]
|
|
773
|
+
},
|
|
774
|
+
{
|
|
775
|
+
id: "mcporter",
|
|
776
|
+
label: "mcporter",
|
|
777
|
+
vendor: "mcp",
|
|
778
|
+
rawNames: ["mcporter"]
|
|
779
|
+
},
|
|
780
|
+
{
|
|
781
|
+
id: "rmcp",
|
|
782
|
+
label: "rmcp",
|
|
783
|
+
vendor: "mcp",
|
|
784
|
+
rawNames: ["rmcp"]
|
|
785
|
+
},
|
|
786
|
+
{
|
|
787
|
+
id: "unnamed_client",
|
|
788
|
+
label: "Unnamed client",
|
|
789
|
+
vendor: "mcp",
|
|
790
|
+
rawNames: [
|
|
791
|
+
"mcp",
|
|
792
|
+
"unknown",
|
|
793
|
+
""
|
|
794
|
+
]
|
|
795
|
+
}
|
|
796
|
+
];
|
|
797
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
798
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
799
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
800
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
536
801
|
const runtimeSchema = z.enum([
|
|
537
802
|
"python3.13",
|
|
538
803
|
"python3.14",
|
|
@@ -610,15 +875,7 @@ z.object({
|
|
|
610
875
|
serverFields: serverFieldsSchema$1,
|
|
611
876
|
source: z.enum(["registry", "defaults"])
|
|
612
877
|
});
|
|
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
|
-
*/
|
|
878
|
+
/** 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
879
|
const clampStringField = (field) => {
|
|
623
880
|
const max = field.maxLength;
|
|
624
881
|
if (max === null) return field;
|
|
@@ -626,6 +883,10 @@ const clampStringField = (field) => {
|
|
|
626
883
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
627
884
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
628
885
|
};
|
|
886
|
+
const unboundedArrayField = (field) => {
|
|
887
|
+
const unbounded = z.array(field.element);
|
|
888
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
889
|
+
};
|
|
629
890
|
const toolDefinitionSchema = z.object({
|
|
630
891
|
name: z.string(),
|
|
631
892
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -638,11 +899,22 @@ const toolDefinitionSchema = z.object({
|
|
|
638
899
|
}).optional()
|
|
639
900
|
});
|
|
640
901
|
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."),
|
|
902
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
903
|
+
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
904
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
644
905
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
645
|
-
}).
|
|
906
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
907
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
908
|
+
scenario: z.string().optional(),
|
|
909
|
+
userPrompt: z.string().optional()
|
|
910
|
+
});
|
|
911
|
+
const blankPositiveTestCase = () => ({
|
|
912
|
+
scenario: "",
|
|
913
|
+
userPrompt: "",
|
|
914
|
+
toolTriggered: "",
|
|
915
|
+
expectedOutput: ""
|
|
916
|
+
});
|
|
917
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
646
918
|
const screenshotEntrySchema = z.object({
|
|
647
919
|
prompt: z.string(),
|
|
648
920
|
url: z.url()
|
|
@@ -955,20 +1227,25 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
955
1227
|
"zh-TW"
|
|
956
1228
|
]);
|
|
957
1229
|
const negativeTestCaseSchema = z.object({
|
|
958
|
-
scenario: z.string(),
|
|
959
|
-
userPrompt: z.string()
|
|
960
|
-
}).
|
|
1230
|
+
scenario: z.string().min(1),
|
|
1231
|
+
userPrompt: z.string().min(1)
|
|
1232
|
+
}).describe("Each case: Scenario + User prompt (the plugin should NOT trigger).");
|
|
1233
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1234
|
+
scenario: z.string().optional(),
|
|
1235
|
+
userPrompt: z.string().optional()
|
|
1236
|
+
});
|
|
1237
|
+
const blankNegativeTestCase = () => ({
|
|
1238
|
+
scenario: "",
|
|
1239
|
+
userPrompt: ""
|
|
1240
|
+
});
|
|
1241
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
961
1242
|
const chatgptToolJustificationSchema = z.object({
|
|
962
1243
|
toolName: z.string(),
|
|
963
1244
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
964
1245
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
965
1246
|
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
1247
|
}).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
|
-
*/
|
|
1248
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
972
1249
|
const chatgptTaglineSchema = z.string().max(30);
|
|
973
1250
|
const chatgptDescriptionSchema = z.string();
|
|
974
1251
|
const chatgptTranslationSchema = z.object({
|
|
@@ -977,34 +1254,32 @@ const chatgptTranslationSchema = z.object({
|
|
|
977
1254
|
description: chatgptDescriptionSchema
|
|
978
1255
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
979
1256
|
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
|
-
*/
|
|
1257
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
984
1258
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
985
1259
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
986
1260
|
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."),
|
|
987
|
-
appName: z.string().describe("The name users will see in ChatGPT and in the
|
|
1261
|
+
appName: z.string().describe("The name users will see in ChatGPT and in the Plugin Directory."),
|
|
988
1262
|
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
989
|
-
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the
|
|
1263
|
+
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the plugin does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the plugin does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
|
|
990
1264
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
991
|
-
developerName: z.string().describe("Developer name shown publicly on the
|
|
1265
|
+
developerName: z.string().describe("Developer name shown publicly on the plugin's directory page."),
|
|
992
1266
|
companyUrl: urlField.describe("Your company's main website URL."),
|
|
993
1267
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
994
1268
|
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
995
|
-
termsOfServiceUrl: urlField.describe("URL to the
|
|
996
|
-
demoRecordingUrl: urlField.describe("URL to a video demonstrating the
|
|
997
|
-
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My
|
|
1269
|
+
termsOfServiceUrl: urlField.describe("URL to the plugin's terms of service."),
|
|
1270
|
+
demoRecordingUrl: urlField.describe("URL to a video demonstrating the plugin, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
1271
|
+
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My plugin links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the plugin does not offer digital goods."),
|
|
998
1272
|
serverUrl: urlField.describe("URL of the MCP server."),
|
|
999
1273
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
1000
1274
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1001
1275
|
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
|
-
|
|
1004
|
-
|
|
1276
|
+
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."),
|
|
1277
|
+
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."),
|
|
1278
|
+
negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 3 negative test cases: prompts where the plugin 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 plugin does not carry, the right brand or domain but an intent the plugin does not serve, or a boundary with a sibling plugin."),
|
|
1279
|
+
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-plugin screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget plugins must show the widget UI; non-widget plugins show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
1005
1280
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1006
1281
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
1007
|
-
releaseNotes: z.string().describe("Publicly displayed on the
|
|
1282
|
+
releaseNotes: z.string().describe("Publicly displayed on the plugin details page.")
|
|
1008
1283
|
});
|
|
1009
1284
|
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1010
1285
|
tagline: z.string().optional(),
|
|
@@ -1015,23 +1290,35 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
1015
1290
|
demoRecordingUrl: z.string().optional(),
|
|
1016
1291
|
serverUrl: z.string().optional(),
|
|
1017
1292
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1293
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1294
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1018
1295
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1019
1296
|
});
|
|
1020
|
-
|
|
1297
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1298
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1021
1299
|
appName: true,
|
|
1022
1300
|
developerName: true,
|
|
1023
1301
|
serverUrl: true,
|
|
1024
1302
|
tools: true,
|
|
1303
|
+
skills: true,
|
|
1025
1304
|
authentication: true
|
|
1026
1305
|
});
|
|
1027
|
-
|
|
1306
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1307
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1028
1308
|
tagline: true,
|
|
1029
1309
|
description: true,
|
|
1030
1310
|
category: true,
|
|
1031
1311
|
testCases: true,
|
|
1032
1312
|
negativeTestCases: true,
|
|
1033
1313
|
toolJustifications: true
|
|
1034
|
-
}).extend({
|
|
1314
|
+
}).extend({
|
|
1315
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1316
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1317
|
+
}).extend({
|
|
1318
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1319
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1320
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1321
|
+
});
|
|
1035
1322
|
const claudeCategorySchema = z.enum([
|
|
1036
1323
|
"Productivity",
|
|
1037
1324
|
"Communication",
|
|
@@ -1077,11 +1364,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1077
1364
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1078
1365
|
"Public documentation for this connector will be live by the publish date."
|
|
1079
1366
|
]);
|
|
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
|
-
*/
|
|
1367
|
+
/** 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
1368
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1086
1369
|
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
1370
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1158,7 +1441,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1158
1441
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1159
1442
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1160
1443
|
});
|
|
1161
|
-
|
|
1444
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1445
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1162
1446
|
serverUrl: true,
|
|
1163
1447
|
name: true,
|
|
1164
1448
|
slug: true,
|
|
@@ -1173,39 +1457,93 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1173
1457
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1174
1458
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1175
1459
|
});
|
|
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
|
-
*/
|
|
1460
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1182
1461
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1183
1462
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1184
1463
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1185
1464
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1186
1465
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1187
1466
|
});
|
|
1188
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1467
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1189
1468
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1190
1469
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1191
1470
|
});
|
|
1471
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1472
|
+
const byField = {};
|
|
1473
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1474
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1475
|
+
return byField;
|
|
1476
|
+
}
|
|
1477
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1478
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1479
|
+
"pass",
|
|
1480
|
+
"fail",
|
|
1481
|
+
"unverified"
|
|
1482
|
+
]);
|
|
1483
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1484
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1485
|
+
claudeai: ["privacyPolicy"]
|
|
1486
|
+
};
|
|
1487
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1488
|
+
const policyDisclosureSchema = z.enum([
|
|
1489
|
+
"dataCategories",
|
|
1490
|
+
"purposesOfUse",
|
|
1491
|
+
"recipients",
|
|
1492
|
+
"retention"
|
|
1493
|
+
]);
|
|
1494
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1495
|
+
field: verifiableUrlFieldSchema,
|
|
1496
|
+
url: z.string(),
|
|
1497
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1498
|
+
reason: z.string(),
|
|
1499
|
+
concerns: z.array(z.string()).optional(),
|
|
1500
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1501
|
+
});
|
|
1502
|
+
const urlVerificationSchema = z.object({
|
|
1503
|
+
verifiedAt: z.coerce.date(),
|
|
1504
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1505
|
+
});
|
|
1506
|
+
const pageKindSchema = z.enum([
|
|
1507
|
+
"expectedDocument",
|
|
1508
|
+
"errorPage",
|
|
1509
|
+
"loginWall",
|
|
1510
|
+
"parkedDomain",
|
|
1511
|
+
"comingSoon",
|
|
1512
|
+
"marketingPage",
|
|
1513
|
+
"unrelatedDocument"
|
|
1514
|
+
]);
|
|
1515
|
+
z.object({
|
|
1516
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1517
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1518
|
+
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.")
|
|
1519
|
+
});
|
|
1192
1520
|
const submissionMetaFieldsSchema = z.object({
|
|
1193
1521
|
id: z.string(),
|
|
1194
1522
|
environmentId: z.string(),
|
|
1195
1523
|
auditId: z.string().nullable(),
|
|
1524
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1196
1525
|
createdAt: z.coerce.date(),
|
|
1197
1526
|
updatedAt: z.coerce.date()
|
|
1198
1527
|
});
|
|
1199
1528
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1200
1529
|
platform: z.literal("claudeai"),
|
|
1201
|
-
formData: claudeSubmissionDraftSchema
|
|
1530
|
+
formData: claudeSubmissionDraftSchema,
|
|
1531
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1202
1532
|
});
|
|
1203
1533
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1204
1534
|
platform: z.literal("chatgpt"),
|
|
1205
|
-
formData: chatgptSubmissionDraftSchema
|
|
1535
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1536
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1206
1537
|
});
|
|
1207
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1538
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1208
1539
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1540
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1541
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1542
|
+
z.literal([
|
|
1543
|
+
100,
|
|
1544
|
+
75,
|
|
1545
|
+
50
|
|
1546
|
+
]);
|
|
1209
1547
|
const subscriptionPlanSchema = z.enum([
|
|
1210
1548
|
"pro",
|
|
1211
1549
|
"business",
|
|
@@ -1217,17 +1555,71 @@ const customerCreditsSchema = z.object({
|
|
|
1217
1555
|
expiresAt: z.number().nullable(),
|
|
1218
1556
|
currency: z.string()
|
|
1219
1557
|
});
|
|
1220
|
-
const customerUsageSchema = z.object({
|
|
1221
|
-
amountInCents: z.number(),
|
|
1222
|
-
currency: z.string(),
|
|
1223
|
-
periodEnd: z.number()
|
|
1224
|
-
});
|
|
1225
1558
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1226
1559
|
z.object({
|
|
1227
1560
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1228
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1229
1561
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1230
1562
|
});
|
|
1563
|
+
const metricsQueueEventSchema = z.object({
|
|
1564
|
+
ts: z.number().int(),
|
|
1565
|
+
method: z.string(),
|
|
1566
|
+
tool: z.string().nullable(),
|
|
1567
|
+
client: z.string(),
|
|
1568
|
+
sessionId: z.string().nullable(),
|
|
1569
|
+
durationMs: z.number().int(),
|
|
1570
|
+
outputTokens: z.number().int().nullable(),
|
|
1571
|
+
errorType: z.enum([
|
|
1572
|
+
"mcp_error",
|
|
1573
|
+
"tool_error",
|
|
1574
|
+
"timeout"
|
|
1575
|
+
]).nullable(),
|
|
1576
|
+
errorCode: z.number().int().nullable()
|
|
1577
|
+
});
|
|
1578
|
+
z.object({
|
|
1579
|
+
v: z.literal(1),
|
|
1580
|
+
envId: z.string(),
|
|
1581
|
+
events: z.array(metricsQueueEventSchema)
|
|
1582
|
+
});
|
|
1583
|
+
z.object({ v: z.number() });
|
|
1584
|
+
const telemetrySignalSchema = z.enum([
|
|
1585
|
+
"logs",
|
|
1586
|
+
"metrics",
|
|
1587
|
+
"traces"
|
|
1588
|
+
]);
|
|
1589
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1590
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1591
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1592
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1593
|
+
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");
|
|
1594
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1595
|
+
id: z.string(),
|
|
1596
|
+
name: otlpHeaderNameSchema,
|
|
1597
|
+
value: otlpHeaderValueSchema,
|
|
1598
|
+
isSecret: z.boolean()
|
|
1599
|
+
});
|
|
1600
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1601
|
+
"credentials",
|
|
1602
|
+
"wrong-path",
|
|
1603
|
+
"wrong-protocol",
|
|
1604
|
+
"invalid-payload",
|
|
1605
|
+
"partial-rejection",
|
|
1606
|
+
"blocked-target",
|
|
1607
|
+
"timeout",
|
|
1608
|
+
"unreachable",
|
|
1609
|
+
"receiver-error",
|
|
1610
|
+
"unexpected-status"
|
|
1611
|
+
]);
|
|
1612
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1613
|
+
z.object({
|
|
1614
|
+
id: z.string(),
|
|
1615
|
+
signal: telemetrySignalSchema,
|
|
1616
|
+
endpoint: otlpEndpointSchema,
|
|
1617
|
+
protocol: otlpProtocolSchema,
|
|
1618
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1619
|
+
status: telemetryDestinationStatusSchema,
|
|
1620
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable(),
|
|
1621
|
+
isScopedToIntentionalRequestsOnly: z.boolean()
|
|
1622
|
+
});
|
|
1231
1623
|
//#endregion
|
|
1232
1624
|
//#region src/auth-scope.ts
|
|
1233
1625
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1326,6 +1718,14 @@ const serverFieldsSchema = z.object({
|
|
|
1326
1718
|
});
|
|
1327
1719
|
//#endregion
|
|
1328
1720
|
//#region src/api.contract.ts
|
|
1721
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1722
|
+
try {
|
|
1723
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1724
|
+
return true;
|
|
1725
|
+
} catch {
|
|
1726
|
+
return false;
|
|
1727
|
+
}
|
|
1728
|
+
};
|
|
1329
1729
|
const deploymentStatusSchema = z.enum([
|
|
1330
1730
|
"ongoing",
|
|
1331
1731
|
"deployed",
|
|
@@ -1354,21 +1754,20 @@ const deploymentSchema = z.object({
|
|
|
1354
1754
|
isCurrent: z.boolean(),
|
|
1355
1755
|
deploymentPageUrl: z.url().nullable()
|
|
1356
1756
|
});
|
|
1357
|
-
const
|
|
1757
|
+
const isValidTimeInput = (value) => {
|
|
1358
1758
|
if (ms(value) !== void 0) return true;
|
|
1359
1759
|
return !Number.isNaN(new Date(value).getTime());
|
|
1360
1760
|
};
|
|
1361
|
-
const
|
|
1761
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1762
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1763
|
+
const createEnvironmentContractV1 = base.route({
|
|
1362
1764
|
path: "/v1/environments",
|
|
1363
1765
|
method: "POST",
|
|
1364
1766
|
summary: "Create an environment",
|
|
1365
1767
|
description: "Create an environment for a project",
|
|
1366
1768
|
tags: ["environments"],
|
|
1367
1769
|
successDescription: "The environment has been created successfully"
|
|
1368
|
-
}).errors({
|
|
1369
|
-
NOT_FOUND: {},
|
|
1370
|
-
BAD_REQUEST: {}
|
|
1371
|
-
}).input(z.object({
|
|
1770
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1372
1771
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1373
1772
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1374
1773
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1381,7 +1780,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1381
1780
|
createdAt: z.coerce.date(),
|
|
1382
1781
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1383
1782
|
}));
|
|
1384
|
-
const getEnvironmentContractV1 =
|
|
1783
|
+
const getEnvironmentContractV1 = base.route({
|
|
1385
1784
|
path: "/v1/environments/{environmentId}",
|
|
1386
1785
|
method: "GET",
|
|
1387
1786
|
summary: "Get an environment",
|
|
@@ -1397,6 +1796,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1397
1796
|
createdAt: z.coerce.date(),
|
|
1398
1797
|
projectId: z.string()
|
|
1399
1798
|
}));
|
|
1799
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1800
|
+
path: "/v1/environments/{environmentId}",
|
|
1801
|
+
method: "DELETE",
|
|
1802
|
+
summary: "Delete an environment",
|
|
1803
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1804
|
+
tags: ["environments"],
|
|
1805
|
+
successDescription: "The environment has been deleted successfully"
|
|
1806
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1400
1807
|
const domainSchema = z.object({
|
|
1401
1808
|
domain: z.string(),
|
|
1402
1809
|
status: z.enum([
|
|
@@ -1438,7 +1845,7 @@ const projectOutputSchema = z.object({
|
|
|
1438
1845
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1439
1846
|
environments: z.array(environmentSchema)
|
|
1440
1847
|
});
|
|
1441
|
-
const getProjectContractV1 =
|
|
1848
|
+
const getProjectContractV1 = base.route({
|
|
1442
1849
|
path: "/v1/projects/{projectId}",
|
|
1443
1850
|
method: "GET",
|
|
1444
1851
|
summary: "Get a project",
|
|
@@ -1446,18 +1853,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1446
1853
|
tags: ["projects"],
|
|
1447
1854
|
successDescription: "The project details"
|
|
1448
1855
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1449
|
-
const listProjectsContractV1 =
|
|
1856
|
+
const listProjectsContractV1 = base.route({
|
|
1450
1857
|
path: "/v1/projects",
|
|
1451
1858
|
method: "GET",
|
|
1452
1859
|
summary: "List projects",
|
|
1453
1860
|
description: "List all projects for a team",
|
|
1454
1861
|
tags: ["projects"],
|
|
1455
1862
|
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({
|
|
1863
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1864
|
+
const createProjectContractV1 = base.route({
|
|
1461
1865
|
path: "/v1/projects",
|
|
1462
1866
|
method: "POST",
|
|
1463
1867
|
summary: "Create a project",
|
|
@@ -1466,7 +1870,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1466
1870
|
successDescription: "The project has been created successfully"
|
|
1467
1871
|
}).errors({
|
|
1468
1872
|
NOT_FOUND: {},
|
|
1469
|
-
BAD_REQUEST: {},
|
|
1470
1873
|
FORBIDDEN: {}
|
|
1471
1874
|
}).input(z.object({
|
|
1472
1875
|
teamId: z.string().optional(),
|
|
@@ -1507,7 +1910,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1507
1910
|
isSecret: z.boolean(),
|
|
1508
1911
|
createdAt: z.coerce.date()
|
|
1509
1912
|
});
|
|
1510
|
-
const listEnvironmentVariablesContractV1 =
|
|
1913
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1511
1914
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1512
1915
|
method: "GET",
|
|
1513
1916
|
summary: "List environment variables",
|
|
@@ -1515,48 +1918,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1515
1918
|
tags: ["environments"],
|
|
1516
1919
|
successDescription: "The list of environment variables"
|
|
1517
1920
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1518
|
-
const createEnvironmentVariablesContractV1 =
|
|
1921
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1519
1922
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1520
1923
|
method: "POST",
|
|
1521
1924
|
summary: "Add environment variables",
|
|
1522
1925
|
description: "Add one or more environment variables to an environment",
|
|
1523
1926
|
tags: ["environments"],
|
|
1524
1927
|
successDescription: "The environment variables have been added successfully"
|
|
1525
|
-
}).errors({
|
|
1526
|
-
NOT_FOUND: {},
|
|
1527
|
-
BAD_REQUEST: {}
|
|
1528
|
-
}).input(z.object({
|
|
1928
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1529
1929
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1530
1930
|
environmentVariables: environmentVariablesSchema
|
|
1531
1931
|
})).output(z.object({ success: z.literal(true) }));
|
|
1532
|
-
const updateEnvironmentVariableContractV1 =
|
|
1932
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1533
1933
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1534
1934
|
method: "PATCH",
|
|
1535
1935
|
summary: "Update an environment variable",
|
|
1536
1936
|
description: "Update an environment variable by ID",
|
|
1537
1937
|
tags: ["environments"],
|
|
1538
1938
|
successDescription: "The environment variable has been updated successfully"
|
|
1539
|
-
}).errors({
|
|
1540
|
-
NOT_FOUND: {},
|
|
1541
|
-
BAD_REQUEST: {}
|
|
1542
|
-
}).input(z.object({
|
|
1939
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1543
1940
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1544
1941
|
key: environmentVariableSchema.shape.key,
|
|
1545
1942
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1546
1943
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1547
1944
|
})).output(z.object({ success: z.literal(true) }));
|
|
1548
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1945
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1549
1946
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1550
1947
|
method: "DELETE",
|
|
1551
1948
|
summary: "Delete an environment variable",
|
|
1552
1949
|
description: "Delete an environment variable by ID",
|
|
1553
1950
|
tags: ["environments"],
|
|
1554
1951
|
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({
|
|
1952
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1953
|
+
const deleteProjectContractV1 = base.route({
|
|
1560
1954
|
path: "/v1/projects/{projectId}",
|
|
1561
1955
|
method: "DELETE",
|
|
1562
1956
|
summary: "Delete a project",
|
|
@@ -1564,7 +1958,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1564
1958
|
tags: ["projects"],
|
|
1565
1959
|
successDescription: "The project has been deleted successfully"
|
|
1566
1960
|
}).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 =
|
|
1961
|
+
const updateProjectContractV1 = base.route({
|
|
1568
1962
|
path: "/v1/projects/{projectId}",
|
|
1569
1963
|
method: "PATCH",
|
|
1570
1964
|
summary: "Update a project",
|
|
@@ -1573,14 +1967,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1573
1967
|
successDescription: "The project has been updated successfully"
|
|
1574
1968
|
}).errors({
|
|
1575
1969
|
NOT_FOUND: {},
|
|
1576
|
-
BAD_REQUEST: {},
|
|
1577
1970
|
FORBIDDEN: {}
|
|
1578
1971
|
}).input(z.object({
|
|
1579
1972
|
projectId: z.string().describe("The ID of the project"),
|
|
1580
1973
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1581
1974
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1582
1975
|
})).output(projectOutputSchema);
|
|
1583
|
-
const deployEnvironmentContractV1 =
|
|
1976
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1584
1977
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1585
1978
|
method: "POST",
|
|
1586
1979
|
summary: "Deploy an environment",
|
|
@@ -1589,29 +1982,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1589
1982
|
successDescription: "The environment has been deployed successfully"
|
|
1590
1983
|
}).errors({
|
|
1591
1984
|
NOT_FOUND: {},
|
|
1592
|
-
BAD_REQUEST: {},
|
|
1593
1985
|
CONFLICT: {}
|
|
1594
1986
|
}).input(z.object({
|
|
1595
1987
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1596
1988
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1597
1989
|
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
1990
|
})).output(deploymentSchema);
|
|
1599
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1991
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1600
1992
|
path: "/v1/deployments/upload",
|
|
1601
1993
|
method: "POST",
|
|
1602
1994
|
summary: "Upload deployment artifacts",
|
|
1603
1995
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1604
1996
|
tags: ["deployments"],
|
|
1605
1997
|
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({
|
|
1998
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1610
1999
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1611
2000
|
token: z.string().describe("Token to identify the source archive"),
|
|
1612
2001
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1613
2002
|
}));
|
|
1614
|
-
const listDeploymentsContractV1 =
|
|
2003
|
+
const listDeploymentsContractV1 = base.route({
|
|
1615
2004
|
path: "/v1/projects/{projectId}/deployments",
|
|
1616
2005
|
method: "GET",
|
|
1617
2006
|
summary: "List project deployments",
|
|
@@ -1623,7 +2012,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1623
2012
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1624
2013
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1625
2014
|
})).output(z.array(deploymentSchema));
|
|
1626
|
-
const getDeploymentContractV1 =
|
|
2015
|
+
const getDeploymentContractV1 = base.route({
|
|
1627
2016
|
path: "/v1/deployments/{deploymentId}",
|
|
1628
2017
|
method: "GET",
|
|
1629
2018
|
summary: "Get a deployment",
|
|
@@ -1646,20 +2035,17 @@ const logEntrySchema = z.object({
|
|
|
1646
2035
|
method: z.string().optional(),
|
|
1647
2036
|
durationInMs: z.number().optional()
|
|
1648
2037
|
});
|
|
1649
|
-
const getLogsContractV1 =
|
|
2038
|
+
const getLogsContractV1 = base.route({
|
|
1650
2039
|
path: "/v1/environments/{environmentId}/logs",
|
|
1651
2040
|
method: "GET",
|
|
1652
2041
|
summary: "Get logs",
|
|
1653
2042
|
description: "Get logs for an environment",
|
|
1654
2043
|
tags: ["environments"],
|
|
1655
2044
|
successDescription: "The logs"
|
|
1656
|
-
}).errors({
|
|
1657
|
-
NOT_FOUND: {},
|
|
1658
|
-
BAD_REQUEST: {}
|
|
1659
|
-
}).input(z.object({
|
|
2045
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1660
2046
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1661
|
-
since:
|
|
1662
|
-
until:
|
|
2047
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2048
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1663
2049
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1664
2050
|
level: z.array(z.enum([
|
|
1665
2051
|
"INFO",
|
|
@@ -1667,23 +2053,20 @@ const getLogsContractV1 = oc.route({
|
|
|
1667
2053
|
"WARNING",
|
|
1668
2054
|
"DEBUG"
|
|
1669
2055
|
])).optional().describe("Filter by log level"),
|
|
1670
|
-
search:
|
|
2056
|
+
search: logSearchSchema.optional().describe("Term to search for in log content"),
|
|
1671
2057
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1672
2058
|
})).output(z.object({
|
|
1673
2059
|
logs: z.array(logEntrySchema),
|
|
1674
2060
|
nextToken: z.string().nullable()
|
|
1675
2061
|
}));
|
|
1676
|
-
const getLatestLogsContractV1 =
|
|
2062
|
+
const getLatestLogsContractV1 = base.route({
|
|
1677
2063
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1678
2064
|
method: "GET",
|
|
1679
2065
|
summary: "Get latest logs",
|
|
1680
2066
|
description: "Get the N most recent logs for an environment",
|
|
1681
2067
|
tags: ["environments"],
|
|
1682
2068
|
successDescription: "The latest logs"
|
|
1683
|
-
}).errors({
|
|
1684
|
-
NOT_FOUND: {},
|
|
1685
|
-
BAD_REQUEST: {}
|
|
1686
|
-
}).input(z.object({
|
|
2069
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1687
2070
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1688
2071
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1689
2072
|
level: z.array(z.enum([
|
|
@@ -1692,9 +2075,9 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1692
2075
|
"WARNING",
|
|
1693
2076
|
"DEBUG"
|
|
1694
2077
|
])).optional().describe("Filter by log level"),
|
|
1695
|
-
search:
|
|
2078
|
+
search: logSearchSchema.optional().describe("Term to search for in log content")
|
|
1696
2079
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1697
|
-
const getDeploymentLogsContractV1 =
|
|
2080
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1698
2081
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1699
2082
|
method: "GET",
|
|
1700
2083
|
summary: "Get deployment logs",
|
|
@@ -1721,22 +2104,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1721
2104
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1722
2105
|
task_count: z.array(analyticsDataPointSchema)
|
|
1723
2106
|
});
|
|
1724
|
-
const getProjectAnalyticsContractV1 =
|
|
2107
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1725
2108
|
path: "/v1/analytics/{projectId}",
|
|
1726
2109
|
method: "GET",
|
|
1727
2110
|
summary: "Get project analytics",
|
|
1728
2111
|
description: "Get analytics data for a project over a time range",
|
|
1729
2112
|
tags: ["analytics"],
|
|
1730
2113
|
successDescription: "The project analytics data"
|
|
1731
|
-
}).errors({
|
|
1732
|
-
NOT_FOUND: {},
|
|
1733
|
-
BAD_REQUEST: {}
|
|
1734
|
-
}).input(z.object({
|
|
2114
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1735
2115
|
projectId: z.string().describe("The ID of the project"),
|
|
1736
2116
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1737
2117
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1738
2118
|
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 <=
|
|
2119
|
+
}).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
2120
|
metadata: z.object({
|
|
1741
2121
|
startTimestamp: z.number(),
|
|
1742
2122
|
endTimestamp: z.number(),
|
|
@@ -1746,7 +2126,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1746
2126
|
}),
|
|
1747
2127
|
timeSeries: analyticsTimeSeriesSchema
|
|
1748
2128
|
}));
|
|
1749
|
-
const
|
|
2129
|
+
const paginatedInsightsInputShape = {
|
|
2130
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2131
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2132
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2133
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2134
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2135
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2136
|
+
};
|
|
2137
|
+
const listIntentsContractV1 = base.route({
|
|
2138
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2139
|
+
method: "GET",
|
|
2140
|
+
summary: "List intents",
|
|
2141
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2142
|
+
tags: ["insights"],
|
|
2143
|
+
successDescription: "The grouped user intents"
|
|
2144
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2145
|
+
...paginatedInsightsInputShape,
|
|
2146
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2147
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2148
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2149
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2150
|
+
})).output(z.object({
|
|
2151
|
+
intents: z.array(z.object({
|
|
2152
|
+
id: z.string(),
|
|
2153
|
+
intentIds: z.array(z.string()).min(1),
|
|
2154
|
+
environmentId: z.string(),
|
|
2155
|
+
message: z.string(),
|
|
2156
|
+
toolName: z.string(),
|
|
2157
|
+
createdAt: z.coerce.date(),
|
|
2158
|
+
occurrenceCount: z.number().int().positive(),
|
|
2159
|
+
clientName: z.string().nullable(),
|
|
2160
|
+
clientId: z.string().nullable(),
|
|
2161
|
+
categories: z.array(z.object({
|
|
2162
|
+
id: z.string(),
|
|
2163
|
+
name: z.string(),
|
|
2164
|
+
color: intentCategoryColorSchema
|
|
2165
|
+
}))
|
|
2166
|
+
})),
|
|
2167
|
+
totalCount: z.number().int().nonnegative()
|
|
2168
|
+
}));
|
|
2169
|
+
const listFeedbacksContractV1 = base.route({
|
|
2170
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2171
|
+
method: "GET",
|
|
2172
|
+
summary: "List feedbacks",
|
|
2173
|
+
description: "List user feedback for an environment over a time range",
|
|
2174
|
+
tags: ["insights"],
|
|
2175
|
+
successDescription: "The user feedback"
|
|
2176
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2177
|
+
...paginatedInsightsInputShape,
|
|
2178
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2179
|
+
})).output(z.object({
|
|
2180
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2181
|
+
totalCount: z.number().int().nonnegative()
|
|
2182
|
+
}));
|
|
2183
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2184
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2185
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2186
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2187
|
+
method: "GET",
|
|
2188
|
+
summary: "List intent categories",
|
|
2189
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2190
|
+
tags: ["insights"],
|
|
2191
|
+
successDescription: "The intent categories"
|
|
2192
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2193
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2194
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2195
|
+
method: "POST",
|
|
2196
|
+
summary: "Create an intent category",
|
|
2197
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2198
|
+
tags: ["insights"],
|
|
2199
|
+
successDescription: "The created intent category"
|
|
2200
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2201
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2202
|
+
name: intentCategoryNameSchema,
|
|
2203
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2204
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2205
|
+
})).output(intentCategorySchema);
|
|
2206
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2207
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2208
|
+
method: "PATCH",
|
|
2209
|
+
summary: "Update an intent category",
|
|
2210
|
+
description: "Rename or recolor an intent category",
|
|
2211
|
+
tags: ["insights"],
|
|
2212
|
+
successDescription: "The updated intent category"
|
|
2213
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2214
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2215
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2216
|
+
name: intentCategoryNameSchema.optional(),
|
|
2217
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2218
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2219
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2220
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2221
|
+
method: "DELETE",
|
|
2222
|
+
summary: "Delete an intent category",
|
|
2223
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2224
|
+
tags: ["insights"],
|
|
2225
|
+
successDescription: "The intent category has been deleted 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
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2230
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2231
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2232
|
+
method: "POST",
|
|
2233
|
+
summary: "Link an intent category",
|
|
2234
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2235
|
+
tags: ["insights"],
|
|
2236
|
+
successDescription: "The intents have been linked successfully"
|
|
2237
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2238
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2239
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2240
|
+
intentIds: categorizableIntentIdsSchema
|
|
2241
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2242
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2243
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2244
|
+
method: "POST",
|
|
2245
|
+
summary: "Unlink an intent category",
|
|
2246
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2247
|
+
tags: ["insights"],
|
|
2248
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2249
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2250
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2251
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2252
|
+
intentIds: categorizableIntentIdsSchema
|
|
2253
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2254
|
+
const listTeamsContractV1 = base.route({
|
|
1750
2255
|
path: "/v1/teams",
|
|
1751
2256
|
method: "GET",
|
|
1752
2257
|
summary: "List teams",
|
|
@@ -1759,7 +2264,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1759
2264
|
createdAt: z.coerce.date(),
|
|
1760
2265
|
hasStripeAccount: z.boolean()
|
|
1761
2266
|
})));
|
|
1762
|
-
const
|
|
2267
|
+
const getTeamUsageContractV1 = base.route({
|
|
2268
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2269
|
+
method: "GET",
|
|
2270
|
+
summary: "Get team usage",
|
|
2271
|
+
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.",
|
|
2272
|
+
tags: ["teams"],
|
|
2273
|
+
successDescription: "The current billing window usage"
|
|
2274
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2275
|
+
teamId: z.string(),
|
|
2276
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2277
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2278
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2279
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2280
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2281
|
+
}));
|
|
2282
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1763
2283
|
path: "/v1/tunnels/ticket",
|
|
1764
2284
|
method: "GET",
|
|
1765
2285
|
summary: "Get a tunnel ticket",
|
|
@@ -1771,16 +2291,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1771
2291
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1772
2292
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1773
2293
|
}));
|
|
1774
|
-
const publishServerContractV1 =
|
|
2294
|
+
const publishServerContractV1 = base.route({
|
|
1775
2295
|
path: "/v1/distribution/publish",
|
|
1776
2296
|
method: "POST",
|
|
1777
2297
|
summary: "Publish a server to the MCP registry",
|
|
1778
2298
|
tags: ["distribution"],
|
|
1779
2299
|
successDescription: "The server has been published successfully"
|
|
1780
|
-
}).errors({
|
|
1781
|
-
NOT_FOUND: {},
|
|
1782
|
-
BAD_REQUEST: {}
|
|
1783
|
-
}).input(z.object({
|
|
2300
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1784
2301
|
projectId: z.string(),
|
|
1785
2302
|
domain: z.string(),
|
|
1786
2303
|
title: z.string().min(1).max(100),
|
|
@@ -1789,17 +2306,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1789
2306
|
iconSrc: z.url().max(255).optional(),
|
|
1790
2307
|
dryRun: z.boolean().optional()
|
|
1791
2308
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1792
|
-
const getServerInfoContractV1 =
|
|
2309
|
+
const getServerInfoContractV1 = base.route({
|
|
1793
2310
|
path: "/v1/distribution/get",
|
|
1794
2311
|
method: "GET",
|
|
1795
2312
|
summary: "Get server info",
|
|
1796
2313
|
description: "Get info about a server",
|
|
1797
2314
|
tags: ["distribution"],
|
|
1798
2315
|
successDescription: "The server info"
|
|
1799
|
-
}).errors({
|
|
1800
|
-
NOT_FOUND: {},
|
|
1801
|
-
BAD_REQUEST: {}
|
|
1802
|
-
}).input(z.object({
|
|
2316
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1803
2317
|
projectId: z.string(),
|
|
1804
2318
|
domain: z.string()
|
|
1805
2319
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1818,7 +2332,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1818
2332
|
isPlaygroundEnabled: z.boolean(),
|
|
1819
2333
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1820
2334
|
});
|
|
1821
|
-
const getPlaygroundContractV1 =
|
|
2335
|
+
const getPlaygroundContractV1 = base.route({
|
|
1822
2336
|
path: "/v1/environments/{environmentId}/playground",
|
|
1823
2337
|
method: "GET",
|
|
1824
2338
|
summary: "Get playground configuration",
|
|
@@ -1826,17 +2340,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1826
2340
|
tags: ["environments"],
|
|
1827
2341
|
successDescription: "The playground configuration"
|
|
1828
2342
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1829
|
-
const upsertPlaygroundContractV1 =
|
|
2343
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1830
2344
|
path: "/v1/environments/{environmentId}/playground",
|
|
1831
2345
|
method: "PUT",
|
|
1832
2346
|
summary: "Update playground configuration",
|
|
1833
2347
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1834
2348
|
tags: ["environments"],
|
|
1835
2349
|
successDescription: "The updated playground configuration"
|
|
1836
|
-
}).errors({
|
|
1837
|
-
NOT_FOUND: {},
|
|
1838
|
-
BAD_REQUEST: {}
|
|
1839
|
-
}).input(z.object({
|
|
2350
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1840
2351
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1841
2352
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1842
2353
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1844,7 +2355,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1844
2355
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1845
2356
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1846
2357
|
})).output(playgroundOutputSchema);
|
|
1847
|
-
const createBeaconContractV1 =
|
|
2358
|
+
const createBeaconContractV1 = base.route({
|
|
1848
2359
|
path: "/v1/beacon/audits",
|
|
1849
2360
|
method: "POST",
|
|
1850
2361
|
summary: "Create a beacon audit",
|
|
@@ -1853,7 +2364,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1853
2364
|
successDescription: "The audit has been created"
|
|
1854
2365
|
}).errors({
|
|
1855
2366
|
NOT_FOUND: {},
|
|
1856
|
-
BAD_REQUEST: {},
|
|
1857
2367
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1858
2368
|
}).input(z.object({
|
|
1859
2369
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1861,7 +2371,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1861
2371
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1862
2372
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1863
2373
|
})).output(z.object({ id: z.string() }));
|
|
1864
|
-
const getBeaconContractV1 =
|
|
2374
|
+
const getBeaconContractV1 = base.route({
|
|
1865
2375
|
path: "/v1/beacon/audits/{auditId}",
|
|
1866
2376
|
method: "GET",
|
|
1867
2377
|
summary: "Get a beacon audit",
|
|
@@ -1876,9 +2386,73 @@ const getBeaconContractV1 = oc.route({
|
|
|
1876
2386
|
createdAt: z.coerce.date(),
|
|
1877
2387
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1878
2388
|
}));
|
|
2389
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2390
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2391
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2392
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2393
|
+
const createSubmissionContractV1 = base.route({
|
|
2394
|
+
path: "/v1/submissions",
|
|
2395
|
+
method: "POST",
|
|
2396
|
+
summary: "Create a submission package",
|
|
2397
|
+
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.",
|
|
2398
|
+
tags: ["submissions"],
|
|
2399
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2400
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2401
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2402
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2403
|
+
})).output(submissionSchema);
|
|
2404
|
+
const listSubmissionsContractV1 = base.route({
|
|
2405
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2406
|
+
method: "GET",
|
|
2407
|
+
summary: "List submission packages",
|
|
2408
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2409
|
+
tags: ["submissions"],
|
|
2410
|
+
successDescription: "The list of submission packages"
|
|
2411
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2412
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2413
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2414
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2415
|
+
})).output(z.array(submissionSchema));
|
|
2416
|
+
const getSubmissionContractV1 = base.route({
|
|
2417
|
+
path: "/v1/submissions/{submissionId}",
|
|
2418
|
+
method: "GET",
|
|
2419
|
+
summary: "Get a submission package",
|
|
2420
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2421
|
+
tags: ["submissions"],
|
|
2422
|
+
successDescription: "The submission package"
|
|
2423
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2424
|
+
const updateSubmissionContractV1 = base.route({
|
|
2425
|
+
path: "/v1/submissions/{submissionId}",
|
|
2426
|
+
method: "PUT",
|
|
2427
|
+
summary: "Update a submission package",
|
|
2428
|
+
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.",
|
|
2429
|
+
tags: ["submissions"],
|
|
2430
|
+
successDescription: "The updated submission package"
|
|
2431
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2432
|
+
submissionId: submissionIdSchema,
|
|
2433
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2434
|
+
formData: claudeSubmissionUpdateSchema
|
|
2435
|
+
}), z.object({
|
|
2436
|
+
submissionId: submissionIdSchema,
|
|
2437
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2438
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2439
|
+
})])).output(submissionSchema);
|
|
1879
2440
|
const contract = {
|
|
1880
|
-
teams: {
|
|
2441
|
+
teams: {
|
|
2442
|
+
list: { v1: listTeamsContractV1 },
|
|
2443
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2444
|
+
},
|
|
1881
2445
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2446
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2447
|
+
intentCategories: {
|
|
2448
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2449
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2450
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2451
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2452
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2453
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2454
|
+
},
|
|
2455
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1882
2456
|
deployments: {
|
|
1883
2457
|
list: { v1: listDeploymentsContractV1 },
|
|
1884
2458
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1888,6 +2462,7 @@ const contract = {
|
|
|
1888
2462
|
environments: {
|
|
1889
2463
|
create: { v1: createEnvironmentContractV1 },
|
|
1890
2464
|
get: { v1: getEnvironmentContractV1 },
|
|
2465
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1891
2466
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1892
2467
|
getLogs: { v1: getLogsContractV1 },
|
|
1893
2468
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1917,6 +2492,12 @@ const contract = {
|
|
|
1917
2492
|
beacon: {
|
|
1918
2493
|
create: { v1: createBeaconContractV1 },
|
|
1919
2494
|
get: { v1: getBeaconContractV1 }
|
|
2495
|
+
},
|
|
2496
|
+
submissions: {
|
|
2497
|
+
create: { v1: createSubmissionContractV1 },
|
|
2498
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2499
|
+
get: { v1: getSubmissionContractV1 },
|
|
2500
|
+
update: { v1: updateSubmissionContractV1 }
|
|
1920
2501
|
}
|
|
1921
2502
|
};
|
|
1922
2503
|
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
@@ -1924,5 +2505,26 @@ const contractForDocs = {
|
|
|
1924
2505
|
...contract,
|
|
1925
2506
|
deployments: deploymentsForDocs
|
|
1926
2507
|
};
|
|
2508
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2509
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2510
|
+
info: {
|
|
2511
|
+
title: "Alpic API",
|
|
2512
|
+
version: "1.0.0"
|
|
2513
|
+
},
|
|
2514
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2515
|
+
security: [{ bearerAuth: [] }],
|
|
2516
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2517
|
+
type: "http",
|
|
2518
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2519
|
+
scheme: "bearer"
|
|
2520
|
+
} } },
|
|
2521
|
+
commonSchemas: {
|
|
2522
|
+
Submission: { schema: submissionSchema },
|
|
2523
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2524
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2525
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2526
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
2527
|
+
}
|
|
2528
|
+
};
|
|
1927
2529
|
//#endregion
|
|
1928
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2530
|
+
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 };
|