@alpic-ai/api 0.0.0-staging.gdfda002 → 0.0.0-staging.ge0a89fd
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 +6285 -94
- package/dist/index.mjs +766 -174
- package/package.json +9 -9
package/dist/index.mjs
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
import * as z$1 from "zod/v4";
|
|
3
3
|
import { oc } from "@orpc/contract";
|
|
4
4
|
import ms from "ms";
|
|
5
|
-
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.0_supports-color@7.2.0_zod@4.5.4/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -179,6 +179,7 @@ const PLATFORM_LABELS = {
|
|
|
179
179
|
};
|
|
180
180
|
const WAF_PLATFORMS = [
|
|
181
181
|
"akamai",
|
|
182
|
+
"cato",
|
|
182
183
|
"cloudflare",
|
|
183
184
|
"fastly"
|
|
184
185
|
];
|
|
@@ -256,6 +257,25 @@ z.object({
|
|
|
256
257
|
clientSecret: z.string(),
|
|
257
258
|
clientScopes: z.array(z.string())
|
|
258
259
|
});
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"admin_adjustment"
|
|
266
|
+
]);
|
|
267
|
+
z.enum(["playground"]);
|
|
268
|
+
z.number().int().min(500);
|
|
269
|
+
const creditActivityEntrySchema = z.object({
|
|
270
|
+
reason: creditEntryReasonSchema,
|
|
271
|
+
day: z.number(),
|
|
272
|
+
amountInNanoUSD: z.number(),
|
|
273
|
+
messageCount: z.number().nullable()
|
|
274
|
+
});
|
|
275
|
+
z.object({
|
|
276
|
+
balanceInNanoUSD: z.number(),
|
|
277
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
278
|
+
});
|
|
259
279
|
const deploymentStatusSchema$1 = z.enum([
|
|
260
280
|
"ongoing",
|
|
261
281
|
"deployed",
|
|
@@ -283,33 +303,18 @@ const deploymentSummarySchema = z.object({
|
|
|
283
303
|
createdAt: z.coerce.date(),
|
|
284
304
|
updatedAt: z.coerce.date()
|
|
285
305
|
});
|
|
286
|
-
/**
|
|
287
|
-
* Public environment
|
|
288
|
-
*
|
|
289
|
-
* Answers anonymously and exposes no OAuth metadata.
|
|
290
|
-
*/
|
|
306
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
291
307
|
const publicEnvironmentSchema = z.object({
|
|
292
308
|
allowsAnonymous: z.literal(true),
|
|
293
309
|
oAuthMetadata: z.strictObject({})
|
|
294
310
|
});
|
|
295
|
-
/**
|
|
296
|
-
* Protected environment with an external resource metadata URL
|
|
297
|
-
*
|
|
298
|
-
* An external resource metadata URL is returned in the WWW-Authenticate header during the first 401 response.
|
|
299
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
300
|
-
*/
|
|
311
|
+
/** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
|
|
301
312
|
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
302
313
|
allowsAnonymous: z.boolean(),
|
|
303
314
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
304
315
|
scope: z.string().optional()
|
|
305
316
|
});
|
|
306
|
-
/**
|
|
307
|
-
* Protected environment with an external authorization server URL
|
|
308
|
-
*
|
|
309
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
310
|
-
* An external authorization server URL is returned when requesting the endpoint.
|
|
311
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
312
|
-
*/
|
|
317
|
+
/** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
|
|
313
318
|
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
314
319
|
allowsAnonymous: z.boolean(),
|
|
315
320
|
oAuthMetadata: z.object({
|
|
@@ -318,12 +323,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
318
323
|
}),
|
|
319
324
|
scope: z.string().optional()
|
|
320
325
|
});
|
|
321
|
-
/**
|
|
322
|
-
* Standalone protected environment
|
|
323
|
-
*
|
|
324
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
325
|
-
* The server itself exposes the /.well-known/oauth-authorization-server endpoint.
|
|
326
|
-
*/
|
|
326
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
327
327
|
const standaloneEnvironmentSchema = z.object({
|
|
328
328
|
allowsAnonymous: z.boolean(),
|
|
329
329
|
oAuthMetadata: z.object({
|
|
@@ -332,13 +332,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
332
332
|
}),
|
|
333
333
|
scope: z.string().optional()
|
|
334
334
|
});
|
|
335
|
-
/**
|
|
336
|
-
* Protected environment without OAuth discovery
|
|
337
|
-
*
|
|
338
|
-
* The server enforces authentication but exposes no OAuth discovery metadata.
|
|
339
|
-
* Neither /.well-known/oauth-protected-resource nor /.well-known/oauth-authorization-server
|
|
340
|
-
* are advertised. Clients must obtain credentials out-of-band.
|
|
341
|
-
*/
|
|
335
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
342
336
|
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
343
337
|
allowsAnonymous: z.literal(false),
|
|
344
338
|
oAuthMetadata: z.strictObject({}),
|
|
@@ -425,14 +419,16 @@ 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()
|
|
429
424
|
});
|
|
430
|
-
z.object({
|
|
425
|
+
const feedbackSchema = z.object({
|
|
431
426
|
id: z.string(),
|
|
432
427
|
createdAt: z.coerce.date(),
|
|
433
428
|
environmentId: z.string(),
|
|
434
429
|
content: z.string(),
|
|
435
|
-
source: z.enum(["model", "user"])
|
|
430
|
+
source: z.enum(["model", "user"]),
|
|
431
|
+
clientName: z.string().nullable()
|
|
436
432
|
});
|
|
437
433
|
z.object({
|
|
438
434
|
content: z.string(),
|
|
@@ -448,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
448
444
|
"pink",
|
|
449
445
|
"gray"
|
|
450
446
|
]);
|
|
451
|
-
intentCategoryColorSchema.options;
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
452
448
|
const intentCategorySchema = z.object({
|
|
453
449
|
id: z.string(),
|
|
454
450
|
createdAt: z.coerce.date(),
|
|
@@ -456,7 +452,7 @@ const intentCategorySchema = z.object({
|
|
|
456
452
|
name: z.string(),
|
|
457
453
|
color: intentCategoryColorSchema
|
|
458
454
|
});
|
|
459
|
-
z.object({
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
460
456
|
id: z.string(),
|
|
461
457
|
name: z.string(),
|
|
462
458
|
color: intentCategoryColorSchema,
|
|
@@ -468,6 +464,7 @@ z.object({
|
|
|
468
464
|
environmentId: z.string(),
|
|
469
465
|
toolName: z.string(),
|
|
470
466
|
message: z.string(),
|
|
467
|
+
clientName: z.string().nullable(),
|
|
471
468
|
categories: z.array(intentCategorySchema)
|
|
472
469
|
});
|
|
473
470
|
const signalCategorySchema = z.object({
|
|
@@ -526,12 +523,262 @@ z.object({
|
|
|
526
523
|
createdAt: z.coerce.date(),
|
|
527
524
|
updatedAt: z.coerce.date()
|
|
528
525
|
});
|
|
526
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
527
|
+
type: z.literal("mcp_request"),
|
|
528
|
+
method: z.string()
|
|
529
|
+
});
|
|
530
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
531
|
+
type: z.literal("mcp_error"),
|
|
532
|
+
method: z.string(),
|
|
533
|
+
error: z.string()
|
|
534
|
+
});
|
|
535
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
529
536
|
z.enum([
|
|
530
537
|
"INFO",
|
|
531
538
|
"WARNING",
|
|
532
539
|
"DEBUG",
|
|
533
540
|
"ERROR"
|
|
534
541
|
]);
|
|
542
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
543
|
+
const MCP_CLIENT_GROUPS = [
|
|
544
|
+
{
|
|
545
|
+
id: "claude_code",
|
|
546
|
+
label: "Claude Code",
|
|
547
|
+
vendor: "anthropic",
|
|
548
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
id: "claude",
|
|
552
|
+
label: "Claude",
|
|
553
|
+
vendor: "anthropic",
|
|
554
|
+
rawNames: [
|
|
555
|
+
"Anthropic/ClaudeAI",
|
|
556
|
+
"claude-ai",
|
|
557
|
+
"claude",
|
|
558
|
+
"Claude",
|
|
559
|
+
"claude-desktop",
|
|
560
|
+
"claude-desktop-3p"
|
|
561
|
+
]
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
id: "claude_mobile",
|
|
565
|
+
label: "Claude mobile",
|
|
566
|
+
vendor: "anthropic",
|
|
567
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
id: "claude_cowork",
|
|
571
|
+
label: "Claude Cowork",
|
|
572
|
+
vendor: "anthropic",
|
|
573
|
+
rawNames: ["Anthropic/Cowork"]
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
id: "claude_toolbox",
|
|
577
|
+
label: "Claude Toolbox",
|
|
578
|
+
vendor: "anthropic",
|
|
579
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
id: "anthropic_api",
|
|
583
|
+
label: "Anthropic API",
|
|
584
|
+
vendor: "anthropic",
|
|
585
|
+
rawNames: ["Anthropic/API"]
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
id: "anthropic_connector_refresh",
|
|
589
|
+
label: "Anthropic (connector refresh)",
|
|
590
|
+
vendor: "anthropic",
|
|
591
|
+
rawNames: ["Anthropic"]
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
id: "codex",
|
|
595
|
+
label: "Codex",
|
|
596
|
+
vendor: "openai",
|
|
597
|
+
rawNames: [
|
|
598
|
+
"codex-mcp-client",
|
|
599
|
+
"codex",
|
|
600
|
+
"Codex",
|
|
601
|
+
"codex-cli",
|
|
602
|
+
"openai-mcp (Codex)"
|
|
603
|
+
]
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
id: "chatgpt",
|
|
607
|
+
label: "ChatGPT",
|
|
608
|
+
vendor: "openai",
|
|
609
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
id: "openai_responses_api",
|
|
613
|
+
label: "OpenAI Responses API",
|
|
614
|
+
vendor: "openai",
|
|
615
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
id: "openai_agent_builder",
|
|
619
|
+
label: "OpenAI Agent Builder",
|
|
620
|
+
vendor: "openai",
|
|
621
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
id: "openai_other",
|
|
625
|
+
label: "OpenAI Other",
|
|
626
|
+
vendor: "openai",
|
|
627
|
+
rawNames: ["openai-mcp"]
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
id: "cursor",
|
|
631
|
+
label: "Cursor",
|
|
632
|
+
vendor: "cursor",
|
|
633
|
+
rawNames: [
|
|
634
|
+
"cursor-vscode",
|
|
635
|
+
"Cursor",
|
|
636
|
+
"cursor"
|
|
637
|
+
]
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
id: "cline",
|
|
641
|
+
label: "Cline",
|
|
642
|
+
vendor: "cline",
|
|
643
|
+
rawNames: [
|
|
644
|
+
"Cline",
|
|
645
|
+
"cline",
|
|
646
|
+
"@cline/core"
|
|
647
|
+
]
|
|
648
|
+
},
|
|
649
|
+
{
|
|
650
|
+
id: "github_copilot",
|
|
651
|
+
label: "GitHub Copilot",
|
|
652
|
+
vendor: "githubCopilot",
|
|
653
|
+
rawNames: [
|
|
654
|
+
"Copilot",
|
|
655
|
+
"github-copilot-developer",
|
|
656
|
+
"Copilot MCP Gateway",
|
|
657
|
+
"Xcode/copilot-xcode"
|
|
658
|
+
]
|
|
659
|
+
},
|
|
660
|
+
{
|
|
661
|
+
id: "gemini_cli",
|
|
662
|
+
label: "Gemini CLI",
|
|
663
|
+
vendor: "google",
|
|
664
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
id: "antigravity",
|
|
668
|
+
label: "Antigravity",
|
|
669
|
+
vendor: "google",
|
|
670
|
+
rawNames: ["antigravity-client"]
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
id: "gemini",
|
|
674
|
+
label: "Gemini",
|
|
675
|
+
vendor: "google",
|
|
676
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
id: "windsurf",
|
|
680
|
+
label: "Windsurf",
|
|
681
|
+
vendor: "windsurf",
|
|
682
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
683
|
+
},
|
|
684
|
+
{
|
|
685
|
+
id: "mistral",
|
|
686
|
+
label: "Mistral / Le Chat",
|
|
687
|
+
vendor: "mistral",
|
|
688
|
+
rawNames: ["Mistral"],
|
|
689
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
id: "n8n",
|
|
693
|
+
label: "n8n",
|
|
694
|
+
vendor: "n8n",
|
|
695
|
+
rawNames: [
|
|
696
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
697
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
698
|
+
"n8n"
|
|
699
|
+
]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "alpic_playground",
|
|
703
|
+
label: "Alpic Playground",
|
|
704
|
+
vendor: "alpic",
|
|
705
|
+
rawNames: ["alpic-playground", "playground"]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
id: "opencode",
|
|
709
|
+
label: "opencode",
|
|
710
|
+
vendor: "opencode",
|
|
711
|
+
rawNames: ["opencode"]
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
id: "zed",
|
|
715
|
+
label: "Zed",
|
|
716
|
+
vendor: "zed",
|
|
717
|
+
rawNames: ["Zed", "zed"]
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
id: "zapier",
|
|
721
|
+
label: "Zapier",
|
|
722
|
+
vendor: "zapier",
|
|
723
|
+
rawNames: ["Zapier", "zapier"]
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
id: "make",
|
|
727
|
+
label: "Make",
|
|
728
|
+
vendor: "make",
|
|
729
|
+
rawNames: ["Make", "make"]
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
id: "librechat",
|
|
733
|
+
label: "LibreChat",
|
|
734
|
+
vendor: "mcp",
|
|
735
|
+
rawNames: ["LibreChat", "librechat"]
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
id: "jan",
|
|
739
|
+
label: "Jan",
|
|
740
|
+
vendor: "mcp",
|
|
741
|
+
rawNames: ["Jan", "jan"]
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
id: "goose",
|
|
745
|
+
label: "goose",
|
|
746
|
+
vendor: "mcp",
|
|
747
|
+
rawNames: ["goose", "Goose"]
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
id: "mcphost",
|
|
751
|
+
label: "mcphost",
|
|
752
|
+
vendor: "mcp",
|
|
753
|
+
rawNames: ["mcphost"]
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
id: "mcporter",
|
|
757
|
+
label: "mcporter",
|
|
758
|
+
vendor: "mcp",
|
|
759
|
+
rawNames: ["mcporter"]
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
id: "rmcp",
|
|
763
|
+
label: "rmcp",
|
|
764
|
+
vendor: "mcp",
|
|
765
|
+
rawNames: ["rmcp"]
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
id: "unnamed_client",
|
|
769
|
+
label: "Unnamed client",
|
|
770
|
+
vendor: "mcp",
|
|
771
|
+
rawNames: [
|
|
772
|
+
"mcp",
|
|
773
|
+
"unknown",
|
|
774
|
+
""
|
|
775
|
+
]
|
|
776
|
+
}
|
|
777
|
+
];
|
|
778
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
779
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
780
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
781
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
535
782
|
const runtimeSchema = z.enum([
|
|
536
783
|
"python3.13",
|
|
537
784
|
"python3.14",
|
|
@@ -609,15 +856,7 @@ z.object({
|
|
|
609
856
|
serverFields: serverFieldsSchema$1,
|
|
610
857
|
source: z.enum(["registry", "defaults"])
|
|
611
858
|
});
|
|
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
|
-
*/
|
|
859
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
621
860
|
const clampStringField = (field) => {
|
|
622
861
|
const max = field.maxLength;
|
|
623
862
|
if (max === null) return field;
|
|
@@ -625,6 +864,10 @@ const clampStringField = (field) => {
|
|
|
625
864
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
626
865
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
627
866
|
};
|
|
867
|
+
const unboundedArrayField = (field) => {
|
|
868
|
+
const unbounded = z.array(field.element);
|
|
869
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
870
|
+
};
|
|
628
871
|
const toolDefinitionSchema = z.object({
|
|
629
872
|
name: z.string(),
|
|
630
873
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -637,11 +880,22 @@ const toolDefinitionSchema = z.object({
|
|
|
637
880
|
}).optional()
|
|
638
881
|
});
|
|
639
882
|
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."),
|
|
883
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
884
|
+
userPrompt: z.string().min(1).describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
642
885
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
643
886
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
644
|
-
}).
|
|
887
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
888
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
889
|
+
scenario: z.string().optional(),
|
|
890
|
+
userPrompt: z.string().optional()
|
|
891
|
+
});
|
|
892
|
+
const blankPositiveTestCase = () => ({
|
|
893
|
+
scenario: "",
|
|
894
|
+
userPrompt: "",
|
|
895
|
+
toolTriggered: "",
|
|
896
|
+
expectedOutput: ""
|
|
897
|
+
});
|
|
898
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
645
899
|
const screenshotEntrySchema = z.object({
|
|
646
900
|
prompt: z.string(),
|
|
647
901
|
url: z.url()
|
|
@@ -954,20 +1208,25 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
954
1208
|
"zh-TW"
|
|
955
1209
|
]);
|
|
956
1210
|
const negativeTestCaseSchema = z.object({
|
|
957
|
-
scenario: z.string(),
|
|
958
|
-
userPrompt: z.string()
|
|
959
|
-
}).
|
|
1211
|
+
scenario: z.string().min(1),
|
|
1212
|
+
userPrompt: z.string().min(1)
|
|
1213
|
+
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1214
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1215
|
+
scenario: z.string().optional(),
|
|
1216
|
+
userPrompt: z.string().optional()
|
|
1217
|
+
});
|
|
1218
|
+
const blankNegativeTestCase = () => ({
|
|
1219
|
+
scenario: "",
|
|
1220
|
+
userPrompt: ""
|
|
1221
|
+
});
|
|
1222
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
960
1223
|
const chatgptToolJustificationSchema = z.object({
|
|
961
1224
|
toolName: z.string(),
|
|
962
1225
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
963
1226
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
964
1227
|
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
965
1228
|
}).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
|
-
*/
|
|
1229
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
971
1230
|
const chatgptTaglineSchema = z.string().max(30);
|
|
972
1231
|
const chatgptDescriptionSchema = z.string();
|
|
973
1232
|
const chatgptTranslationSchema = z.object({
|
|
@@ -976,10 +1235,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
976
1235
|
description: chatgptDescriptionSchema
|
|
977
1236
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
978
1237
|
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
|
-
*/
|
|
1238
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
983
1239
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
984
1240
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
985
1241
|
logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
|
|
@@ -998,8 +1254,9 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
998
1254
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
999
1255
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1000
1256
|
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
|
|
1001
|
-
|
|
1002
|
-
|
|
1257
|
+
skills: z.array(chatgptSkillSchema).optional().describe("Skills the server exposes over MCP (auto-populated from the production server's manifest). Left unset when the server does not advertise the skills extension, which is a different state from advertising it and exposing none."),
|
|
1258
|
+
testCases: z.array(positiveTestCaseSchema).length(5).describe("Exactly 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Collectively cover the full capability across different flow stages (initial search or browse, market or locale handling, post-interaction detail, an action ChatGPT performs on the user's behalf, and a conversion or secondary tool) rather than five variations of the same first step."),
|
|
1259
|
+
negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
1003
1260
|
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
1004
1261
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1005
1262
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
@@ -1014,23 +1271,35 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
1014
1271
|
demoRecordingUrl: z.string().optional(),
|
|
1015
1272
|
serverUrl: z.string().optional(),
|
|
1016
1273
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1274
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1275
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1017
1276
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1018
1277
|
});
|
|
1019
|
-
|
|
1278
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1279
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1020
1280
|
appName: true,
|
|
1021
1281
|
developerName: true,
|
|
1022
1282
|
serverUrl: true,
|
|
1023
1283
|
tools: true,
|
|
1284
|
+
skills: true,
|
|
1024
1285
|
authentication: true
|
|
1025
1286
|
});
|
|
1026
|
-
|
|
1287
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1288
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1027
1289
|
tagline: true,
|
|
1028
1290
|
description: true,
|
|
1029
1291
|
category: true,
|
|
1030
1292
|
testCases: true,
|
|
1031
1293
|
negativeTestCases: true,
|
|
1032
1294
|
toolJustifications: true
|
|
1033
|
-
}).extend({
|
|
1295
|
+
}).extend({
|
|
1296
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1297
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1298
|
+
}).extend({
|
|
1299
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1300
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1301
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1302
|
+
});
|
|
1034
1303
|
const claudeCategorySchema = z.enum([
|
|
1035
1304
|
"Productivity",
|
|
1036
1305
|
"Communication",
|
|
@@ -1076,11 +1345,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1076
1345
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1077
1346
|
"Public documentation for this connector will be live by the publish date."
|
|
1078
1347
|
]);
|
|
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
|
-
*/
|
|
1348
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
1084
1349
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1085
1350
|
serverUrl: z.url().describe(`The full https:// URL where your MCP server is hosted and reachable. In the claude.ai wizard this is read live
|
|
1086
1351
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1157,7 +1422,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1157
1422
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1158
1423
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1159
1424
|
});
|
|
1160
|
-
|
|
1425
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1426
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1161
1427
|
serverUrl: true,
|
|
1162
1428
|
name: true,
|
|
1163
1429
|
slug: true,
|
|
@@ -1172,39 +1438,93 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1172
1438
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1173
1439
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1174
1440
|
});
|
|
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
|
-
*/
|
|
1441
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1181
1442
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1182
1443
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1183
1444
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1184
1445
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1185
1446
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1186
1447
|
});
|
|
1187
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1448
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1188
1449
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1189
1450
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1190
1451
|
});
|
|
1452
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1453
|
+
const byField = {};
|
|
1454
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1455
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1456
|
+
return byField;
|
|
1457
|
+
}
|
|
1458
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1459
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1460
|
+
"pass",
|
|
1461
|
+
"fail",
|
|
1462
|
+
"unverified"
|
|
1463
|
+
]);
|
|
1464
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1465
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1466
|
+
claudeai: ["privacyPolicy"]
|
|
1467
|
+
};
|
|
1468
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1469
|
+
const policyDisclosureSchema = z.enum([
|
|
1470
|
+
"dataCategories",
|
|
1471
|
+
"purposesOfUse",
|
|
1472
|
+
"recipients",
|
|
1473
|
+
"retention"
|
|
1474
|
+
]);
|
|
1475
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1476
|
+
field: verifiableUrlFieldSchema,
|
|
1477
|
+
url: z.string(),
|
|
1478
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1479
|
+
reason: z.string(),
|
|
1480
|
+
concerns: z.array(z.string()).optional(),
|
|
1481
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1482
|
+
});
|
|
1483
|
+
const urlVerificationSchema = z.object({
|
|
1484
|
+
verifiedAt: z.coerce.date(),
|
|
1485
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1486
|
+
});
|
|
1487
|
+
const pageKindSchema = z.enum([
|
|
1488
|
+
"expectedDocument",
|
|
1489
|
+
"errorPage",
|
|
1490
|
+
"loginWall",
|
|
1491
|
+
"parkedDomain",
|
|
1492
|
+
"comingSoon",
|
|
1493
|
+
"marketingPage",
|
|
1494
|
+
"unrelatedDocument"
|
|
1495
|
+
]);
|
|
1496
|
+
z.object({
|
|
1497
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1498
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1499
|
+
missingDisclosures: z.array(policyDisclosureSchema).describe("For a privacy policy only: which of the four required disclosures the text does not cover. Empty for every other page kind.")
|
|
1500
|
+
});
|
|
1191
1501
|
const submissionMetaFieldsSchema = z.object({
|
|
1192
1502
|
id: z.string(),
|
|
1193
1503
|
environmentId: z.string(),
|
|
1194
1504
|
auditId: z.string().nullable(),
|
|
1505
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1195
1506
|
createdAt: z.coerce.date(),
|
|
1196
1507
|
updatedAt: z.coerce.date()
|
|
1197
1508
|
});
|
|
1198
1509
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1199
1510
|
platform: z.literal("claudeai"),
|
|
1200
|
-
formData: claudeSubmissionDraftSchema
|
|
1511
|
+
formData: claudeSubmissionDraftSchema,
|
|
1512
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1201
1513
|
});
|
|
1202
1514
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1203
1515
|
platform: z.literal("chatgpt"),
|
|
1204
|
-
formData: chatgptSubmissionDraftSchema
|
|
1516
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1517
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1205
1518
|
});
|
|
1206
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1519
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1207
1520
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1521
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1522
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1523
|
+
z.literal([
|
|
1524
|
+
100,
|
|
1525
|
+
75,
|
|
1526
|
+
50
|
|
1527
|
+
]);
|
|
1208
1528
|
const subscriptionPlanSchema = z.enum([
|
|
1209
1529
|
"pro",
|
|
1210
1530
|
"business",
|
|
@@ -1216,17 +1536,70 @@ const customerCreditsSchema = z.object({
|
|
|
1216
1536
|
expiresAt: z.number().nullable(),
|
|
1217
1537
|
currency: z.string()
|
|
1218
1538
|
});
|
|
1219
|
-
const customerUsageSchema = z.object({
|
|
1220
|
-
amountInCents: z.number(),
|
|
1221
|
-
currency: z.string(),
|
|
1222
|
-
periodEnd: z.number()
|
|
1223
|
-
});
|
|
1224
1539
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1225
1540
|
z.object({
|
|
1226
1541
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1227
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1228
1542
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1229
1543
|
});
|
|
1544
|
+
const metricsQueueEventSchema = z.object({
|
|
1545
|
+
ts: z.number().int(),
|
|
1546
|
+
method: z.string(),
|
|
1547
|
+
tool: z.string().nullable(),
|
|
1548
|
+
client: z.string(),
|
|
1549
|
+
sessionId: z.string().nullable(),
|
|
1550
|
+
durationMs: z.number().int(),
|
|
1551
|
+
outputTokens: z.number().int().nullable(),
|
|
1552
|
+
errorType: z.enum([
|
|
1553
|
+
"mcp_error",
|
|
1554
|
+
"tool_error",
|
|
1555
|
+
"timeout"
|
|
1556
|
+
]).nullable(),
|
|
1557
|
+
errorCode: z.number().int().nullable()
|
|
1558
|
+
});
|
|
1559
|
+
z.object({
|
|
1560
|
+
v: z.literal(1),
|
|
1561
|
+
envId: z.string(),
|
|
1562
|
+
events: z.array(metricsQueueEventSchema)
|
|
1563
|
+
});
|
|
1564
|
+
z.object({ v: z.number() });
|
|
1565
|
+
const telemetrySignalSchema = z.enum([
|
|
1566
|
+
"logs",
|
|
1567
|
+
"metrics",
|
|
1568
|
+
"traces"
|
|
1569
|
+
]);
|
|
1570
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1571
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1572
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1573
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1574
|
+
const otlpHeaderValueSchema = z.string().trim().max(OTLP_HEADER_VALUE_MAX_LENGTH).refine((value) => !/[\r\n]/.test(value), "Line breaks are not allowed in a header value");
|
|
1575
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1576
|
+
id: z.string(),
|
|
1577
|
+
name: otlpHeaderNameSchema,
|
|
1578
|
+
value: otlpHeaderValueSchema,
|
|
1579
|
+
isSecret: z.boolean()
|
|
1580
|
+
});
|
|
1581
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1582
|
+
"credentials",
|
|
1583
|
+
"wrong-path",
|
|
1584
|
+
"wrong-protocol",
|
|
1585
|
+
"invalid-payload",
|
|
1586
|
+
"partial-rejection",
|
|
1587
|
+
"blocked-target",
|
|
1588
|
+
"timeout",
|
|
1589
|
+
"unreachable",
|
|
1590
|
+
"receiver-error",
|
|
1591
|
+
"unexpected-status"
|
|
1592
|
+
]);
|
|
1593
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1594
|
+
z.object({
|
|
1595
|
+
id: z.string(),
|
|
1596
|
+
signal: telemetrySignalSchema,
|
|
1597
|
+
endpoint: otlpEndpointSchema,
|
|
1598
|
+
protocol: otlpProtocolSchema,
|
|
1599
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1600
|
+
status: telemetryDestinationStatusSchema,
|
|
1601
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1602
|
+
});
|
|
1230
1603
|
//#endregion
|
|
1231
1604
|
//#region src/auth-scope.ts
|
|
1232
1605
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1269,7 +1642,10 @@ const RESERVED_KEYS = [
|
|
|
1269
1642
|
"BUILD_ARG_START_COMMAND",
|
|
1270
1643
|
"ALPIC_HOST",
|
|
1271
1644
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1272
|
-
"ALPIC_INTENT_META_KEY"
|
|
1645
|
+
"ALPIC_INTENT_META_KEY",
|
|
1646
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1647
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1648
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1273
1649
|
];
|
|
1274
1650
|
const environmentVariableSchema = z.object({
|
|
1275
1651
|
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 +1698,14 @@ const serverFieldsSchema = z.object({
|
|
|
1322
1698
|
});
|
|
1323
1699
|
//#endregion
|
|
1324
1700
|
//#region src/api.contract.ts
|
|
1701
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1702
|
+
try {
|
|
1703
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1704
|
+
return true;
|
|
1705
|
+
} catch {
|
|
1706
|
+
return false;
|
|
1707
|
+
}
|
|
1708
|
+
};
|
|
1325
1709
|
const deploymentStatusSchema = z.enum([
|
|
1326
1710
|
"ongoing",
|
|
1327
1711
|
"deployed",
|
|
@@ -1350,21 +1734,20 @@ const deploymentSchema = z.object({
|
|
|
1350
1734
|
isCurrent: z.boolean(),
|
|
1351
1735
|
deploymentPageUrl: z.url().nullable()
|
|
1352
1736
|
});
|
|
1353
|
-
const
|
|
1737
|
+
const isValidTimeInput = (value) => {
|
|
1354
1738
|
if (ms(value) !== void 0) return true;
|
|
1355
1739
|
return !Number.isNaN(new Date(value).getTime());
|
|
1356
1740
|
};
|
|
1357
|
-
const
|
|
1741
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1742
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1743
|
+
const createEnvironmentContractV1 = base.route({
|
|
1358
1744
|
path: "/v1/environments",
|
|
1359
1745
|
method: "POST",
|
|
1360
1746
|
summary: "Create an environment",
|
|
1361
1747
|
description: "Create an environment for a project",
|
|
1362
1748
|
tags: ["environments"],
|
|
1363
1749
|
successDescription: "The environment has been created successfully"
|
|
1364
|
-
}).errors({
|
|
1365
|
-
NOT_FOUND: {},
|
|
1366
|
-
BAD_REQUEST: {}
|
|
1367
|
-
}).input(z.object({
|
|
1750
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1368
1751
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1369
1752
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1370
1753
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1377,7 +1760,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1377
1760
|
createdAt: z.coerce.date(),
|
|
1378
1761
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1379
1762
|
}));
|
|
1380
|
-
const getEnvironmentContractV1 =
|
|
1763
|
+
const getEnvironmentContractV1 = base.route({
|
|
1381
1764
|
path: "/v1/environments/{environmentId}",
|
|
1382
1765
|
method: "GET",
|
|
1383
1766
|
summary: "Get an environment",
|
|
@@ -1393,6 +1776,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1393
1776
|
createdAt: z.coerce.date(),
|
|
1394
1777
|
projectId: z.string()
|
|
1395
1778
|
}));
|
|
1779
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1780
|
+
path: "/v1/environments/{environmentId}",
|
|
1781
|
+
method: "DELETE",
|
|
1782
|
+
summary: "Delete an environment",
|
|
1783
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1784
|
+
tags: ["environments"],
|
|
1785
|
+
successDescription: "The environment has been deleted successfully"
|
|
1786
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1396
1787
|
const domainSchema = z.object({
|
|
1397
1788
|
domain: z.string(),
|
|
1398
1789
|
status: z.enum([
|
|
@@ -1434,7 +1825,7 @@ const projectOutputSchema = z.object({
|
|
|
1434
1825
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1435
1826
|
environments: z.array(environmentSchema)
|
|
1436
1827
|
});
|
|
1437
|
-
const getProjectContractV1 =
|
|
1828
|
+
const getProjectContractV1 = base.route({
|
|
1438
1829
|
path: "/v1/projects/{projectId}",
|
|
1439
1830
|
method: "GET",
|
|
1440
1831
|
summary: "Get a project",
|
|
@@ -1442,18 +1833,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1442
1833
|
tags: ["projects"],
|
|
1443
1834
|
successDescription: "The project details"
|
|
1444
1835
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1445
|
-
const listProjectsContractV1 =
|
|
1836
|
+
const listProjectsContractV1 = base.route({
|
|
1446
1837
|
path: "/v1/projects",
|
|
1447
1838
|
method: "GET",
|
|
1448
1839
|
summary: "List projects",
|
|
1449
1840
|
description: "List all projects for a team",
|
|
1450
1841
|
tags: ["projects"],
|
|
1451
1842
|
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({
|
|
1843
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1844
|
+
const createProjectContractV1 = base.route({
|
|
1457
1845
|
path: "/v1/projects",
|
|
1458
1846
|
method: "POST",
|
|
1459
1847
|
summary: "Create a project",
|
|
@@ -1462,7 +1850,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1462
1850
|
successDescription: "The project has been created successfully"
|
|
1463
1851
|
}).errors({
|
|
1464
1852
|
NOT_FOUND: {},
|
|
1465
|
-
BAD_REQUEST: {},
|
|
1466
1853
|
FORBIDDEN: {}
|
|
1467
1854
|
}).input(z.object({
|
|
1468
1855
|
teamId: z.string().optional(),
|
|
@@ -1503,7 +1890,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1503
1890
|
isSecret: z.boolean(),
|
|
1504
1891
|
createdAt: z.coerce.date()
|
|
1505
1892
|
});
|
|
1506
|
-
const listEnvironmentVariablesContractV1 =
|
|
1893
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1507
1894
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1508
1895
|
method: "GET",
|
|
1509
1896
|
summary: "List environment variables",
|
|
@@ -1511,48 +1898,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1511
1898
|
tags: ["environments"],
|
|
1512
1899
|
successDescription: "The list of environment variables"
|
|
1513
1900
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1514
|
-
const createEnvironmentVariablesContractV1 =
|
|
1901
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1515
1902
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1516
1903
|
method: "POST",
|
|
1517
1904
|
summary: "Add environment variables",
|
|
1518
1905
|
description: "Add one or more environment variables to an environment",
|
|
1519
1906
|
tags: ["environments"],
|
|
1520
1907
|
successDescription: "The environment variables have been added successfully"
|
|
1521
|
-
}).errors({
|
|
1522
|
-
NOT_FOUND: {},
|
|
1523
|
-
BAD_REQUEST: {}
|
|
1524
|
-
}).input(z.object({
|
|
1908
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1525
1909
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1526
1910
|
environmentVariables: environmentVariablesSchema
|
|
1527
1911
|
})).output(z.object({ success: z.literal(true) }));
|
|
1528
|
-
const updateEnvironmentVariableContractV1 =
|
|
1912
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1529
1913
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1530
1914
|
method: "PATCH",
|
|
1531
1915
|
summary: "Update an environment variable",
|
|
1532
1916
|
description: "Update an environment variable by ID",
|
|
1533
1917
|
tags: ["environments"],
|
|
1534
1918
|
successDescription: "The environment variable has been updated successfully"
|
|
1535
|
-
}).errors({
|
|
1536
|
-
NOT_FOUND: {},
|
|
1537
|
-
BAD_REQUEST: {}
|
|
1538
|
-
}).input(z.object({
|
|
1919
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1539
1920
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1540
1921
|
key: environmentVariableSchema.shape.key,
|
|
1541
1922
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1542
1923
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1543
1924
|
})).output(z.object({ success: z.literal(true) }));
|
|
1544
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1925
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1545
1926
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1546
1927
|
method: "DELETE",
|
|
1547
1928
|
summary: "Delete an environment variable",
|
|
1548
1929
|
description: "Delete an environment variable by ID",
|
|
1549
1930
|
tags: ["environments"],
|
|
1550
1931
|
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({
|
|
1932
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1933
|
+
const deleteProjectContractV1 = base.route({
|
|
1556
1934
|
path: "/v1/projects/{projectId}",
|
|
1557
1935
|
method: "DELETE",
|
|
1558
1936
|
summary: "Delete a project",
|
|
@@ -1560,7 +1938,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1560
1938
|
tags: ["projects"],
|
|
1561
1939
|
successDescription: "The project has been deleted successfully"
|
|
1562
1940
|
}).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 =
|
|
1941
|
+
const updateProjectContractV1 = base.route({
|
|
1564
1942
|
path: "/v1/projects/{projectId}",
|
|
1565
1943
|
method: "PATCH",
|
|
1566
1944
|
summary: "Update a project",
|
|
@@ -1569,14 +1947,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1569
1947
|
successDescription: "The project has been updated successfully"
|
|
1570
1948
|
}).errors({
|
|
1571
1949
|
NOT_FOUND: {},
|
|
1572
|
-
BAD_REQUEST: {},
|
|
1573
1950
|
FORBIDDEN: {}
|
|
1574
1951
|
}).input(z.object({
|
|
1575
1952
|
projectId: z.string().describe("The ID of the project"),
|
|
1576
1953
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1577
1954
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1578
1955
|
})).output(projectOutputSchema);
|
|
1579
|
-
const deployEnvironmentContractV1 =
|
|
1956
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1580
1957
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1581
1958
|
method: "POST",
|
|
1582
1959
|
summary: "Deploy an environment",
|
|
@@ -1585,28 +1962,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1585
1962
|
successDescription: "The environment has been deployed successfully"
|
|
1586
1963
|
}).errors({
|
|
1587
1964
|
NOT_FOUND: {},
|
|
1588
|
-
|
|
1965
|
+
CONFLICT: {}
|
|
1589
1966
|
}).input(z.object({
|
|
1590
1967
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1591
1968
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1592
1969
|
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.")
|
|
1593
1970
|
})).output(deploymentSchema);
|
|
1594
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1971
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1595
1972
|
path: "/v1/deployments/upload",
|
|
1596
1973
|
method: "POST",
|
|
1597
1974
|
summary: "Upload deployment artifacts",
|
|
1598
1975
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1599
1976
|
tags: ["deployments"],
|
|
1600
1977
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1601
|
-
}).errors({
|
|
1602
|
-
NOT_FOUND: {},
|
|
1603
|
-
BAD_REQUEST: {}
|
|
1604
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1978
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1605
1979
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1606
1980
|
token: z.string().describe("Token to identify the source archive"),
|
|
1607
1981
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1608
1982
|
}));
|
|
1609
|
-
const listDeploymentsContractV1 =
|
|
1983
|
+
const listDeploymentsContractV1 = base.route({
|
|
1610
1984
|
path: "/v1/projects/{projectId}/deployments",
|
|
1611
1985
|
method: "GET",
|
|
1612
1986
|
summary: "List project deployments",
|
|
@@ -1618,7 +1992,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1618
1992
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1619
1993
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1620
1994
|
})).output(z.array(deploymentSchema));
|
|
1621
|
-
const getDeploymentContractV1 =
|
|
1995
|
+
const getDeploymentContractV1 = base.route({
|
|
1622
1996
|
path: "/v1/deployments/{deploymentId}",
|
|
1623
1997
|
method: "GET",
|
|
1624
1998
|
summary: "Get a deployment",
|
|
@@ -1641,20 +2015,17 @@ const logEntrySchema = z.object({
|
|
|
1641
2015
|
method: z.string().optional(),
|
|
1642
2016
|
durationInMs: z.number().optional()
|
|
1643
2017
|
});
|
|
1644
|
-
const getLogsContractV1 =
|
|
2018
|
+
const getLogsContractV1 = base.route({
|
|
1645
2019
|
path: "/v1/environments/{environmentId}/logs",
|
|
1646
2020
|
method: "GET",
|
|
1647
2021
|
summary: "Get logs",
|
|
1648
2022
|
description: "Get logs for an environment",
|
|
1649
2023
|
tags: ["environments"],
|
|
1650
2024
|
successDescription: "The logs"
|
|
1651
|
-
}).errors({
|
|
1652
|
-
NOT_FOUND: {},
|
|
1653
|
-
BAD_REQUEST: {}
|
|
1654
|
-
}).input(z.object({
|
|
2025
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1655
2026
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1656
|
-
since:
|
|
1657
|
-
until:
|
|
2027
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2028
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1658
2029
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1659
2030
|
level: z.array(z.enum([
|
|
1660
2031
|
"INFO",
|
|
@@ -1668,17 +2039,14 @@ const getLogsContractV1 = oc.route({
|
|
|
1668
2039
|
logs: z.array(logEntrySchema),
|
|
1669
2040
|
nextToken: z.string().nullable()
|
|
1670
2041
|
}));
|
|
1671
|
-
const getLatestLogsContractV1 =
|
|
2042
|
+
const getLatestLogsContractV1 = base.route({
|
|
1672
2043
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1673
2044
|
method: "GET",
|
|
1674
2045
|
summary: "Get latest logs",
|
|
1675
2046
|
description: "Get the N most recent logs for an environment",
|
|
1676
2047
|
tags: ["environments"],
|
|
1677
2048
|
successDescription: "The latest logs"
|
|
1678
|
-
}).errors({
|
|
1679
|
-
NOT_FOUND: {},
|
|
1680
|
-
BAD_REQUEST: {}
|
|
1681
|
-
}).input(z.object({
|
|
2049
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1682
2050
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1683
2051
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1684
2052
|
level: z.array(z.enum([
|
|
@@ -1689,7 +2057,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1689
2057
|
])).optional().describe("Filter by log level"),
|
|
1690
2058
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1691
2059
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1692
|
-
const getDeploymentLogsContractV1 =
|
|
2060
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1693
2061
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1694
2062
|
method: "GET",
|
|
1695
2063
|
summary: "Get deployment logs",
|
|
@@ -1716,22 +2084,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1716
2084
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1717
2085
|
task_count: z.array(analyticsDataPointSchema)
|
|
1718
2086
|
});
|
|
1719
|
-
const getProjectAnalyticsContractV1 =
|
|
2087
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1720
2088
|
path: "/v1/analytics/{projectId}",
|
|
1721
2089
|
method: "GET",
|
|
1722
2090
|
summary: "Get project analytics",
|
|
1723
2091
|
description: "Get analytics data for a project over a time range",
|
|
1724
2092
|
tags: ["analytics"],
|
|
1725
2093
|
successDescription: "The project analytics data"
|
|
1726
|
-
}).errors({
|
|
1727
|
-
NOT_FOUND: {},
|
|
1728
|
-
BAD_REQUEST: {}
|
|
1729
|
-
}).input(z.object({
|
|
2094
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1730
2095
|
projectId: z.string().describe("The ID of the project"),
|
|
1731
2096
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1732
2097
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1733
2098
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1734
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2099
|
+
}).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({
|
|
1735
2100
|
metadata: z.object({
|
|
1736
2101
|
startTimestamp: z.number(),
|
|
1737
2102
|
endTimestamp: z.number(),
|
|
@@ -1741,7 +2106,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1741
2106
|
}),
|
|
1742
2107
|
timeSeries: analyticsTimeSeriesSchema
|
|
1743
2108
|
}));
|
|
1744
|
-
const
|
|
2109
|
+
const paginatedInsightsInputShape = {
|
|
2110
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2111
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2112
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2113
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2114
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2115
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2116
|
+
};
|
|
2117
|
+
const listIntentsContractV1 = base.route({
|
|
2118
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2119
|
+
method: "GET",
|
|
2120
|
+
summary: "List intents",
|
|
2121
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2122
|
+
tags: ["insights"],
|
|
2123
|
+
successDescription: "The grouped user intents"
|
|
2124
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2125
|
+
...paginatedInsightsInputShape,
|
|
2126
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2127
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2128
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2129
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2130
|
+
})).output(z.object({
|
|
2131
|
+
intents: z.array(z.object({
|
|
2132
|
+
id: z.string(),
|
|
2133
|
+
intentIds: z.array(z.string()).min(1),
|
|
2134
|
+
environmentId: z.string(),
|
|
2135
|
+
message: z.string(),
|
|
2136
|
+
toolName: z.string(),
|
|
2137
|
+
createdAt: z.coerce.date(),
|
|
2138
|
+
occurrenceCount: z.number().int().positive(),
|
|
2139
|
+
clientName: z.string().nullable(),
|
|
2140
|
+
clientId: z.string().nullable(),
|
|
2141
|
+
categories: z.array(z.object({
|
|
2142
|
+
id: z.string(),
|
|
2143
|
+
name: z.string(),
|
|
2144
|
+
color: intentCategoryColorSchema
|
|
2145
|
+
}))
|
|
2146
|
+
})),
|
|
2147
|
+
totalCount: z.number().int().nonnegative()
|
|
2148
|
+
}));
|
|
2149
|
+
const listFeedbacksContractV1 = base.route({
|
|
2150
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2151
|
+
method: "GET",
|
|
2152
|
+
summary: "List feedbacks",
|
|
2153
|
+
description: "List user feedback for an environment over a time range",
|
|
2154
|
+
tags: ["insights"],
|
|
2155
|
+
successDescription: "The user feedback"
|
|
2156
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2157
|
+
...paginatedInsightsInputShape,
|
|
2158
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2159
|
+
})).output(z.object({
|
|
2160
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2161
|
+
totalCount: z.number().int().nonnegative()
|
|
2162
|
+
}));
|
|
2163
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2164
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2165
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2166
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2167
|
+
method: "GET",
|
|
2168
|
+
summary: "List intent categories",
|
|
2169
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2170
|
+
tags: ["insights"],
|
|
2171
|
+
successDescription: "The intent categories"
|
|
2172
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2173
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2174
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2175
|
+
method: "POST",
|
|
2176
|
+
summary: "Create an intent category",
|
|
2177
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2178
|
+
tags: ["insights"],
|
|
2179
|
+
successDescription: "The created intent category"
|
|
2180
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2181
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2182
|
+
name: intentCategoryNameSchema,
|
|
2183
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2184
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2185
|
+
})).output(intentCategorySchema);
|
|
2186
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2187
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2188
|
+
method: "PATCH",
|
|
2189
|
+
summary: "Update an intent category",
|
|
2190
|
+
description: "Rename or recolor an intent category",
|
|
2191
|
+
tags: ["insights"],
|
|
2192
|
+
successDescription: "The updated intent category"
|
|
2193
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2194
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2195
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2196
|
+
name: intentCategoryNameSchema.optional(),
|
|
2197
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2198
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2199
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2200
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2201
|
+
method: "DELETE",
|
|
2202
|
+
summary: "Delete an intent category",
|
|
2203
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2204
|
+
tags: ["insights"],
|
|
2205
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2206
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2207
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2208
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2209
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2210
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2211
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2212
|
+
method: "POST",
|
|
2213
|
+
summary: "Link an intent category",
|
|
2214
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2215
|
+
tags: ["insights"],
|
|
2216
|
+
successDescription: "The intents have been linked successfully"
|
|
2217
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2218
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2219
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2220
|
+
intentIds: categorizableIntentIdsSchema
|
|
2221
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2222
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2223
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2224
|
+
method: "POST",
|
|
2225
|
+
summary: "Unlink an intent category",
|
|
2226
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2227
|
+
tags: ["insights"],
|
|
2228
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2229
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2230
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2231
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2232
|
+
intentIds: categorizableIntentIdsSchema
|
|
2233
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2234
|
+
const listTeamsContractV1 = base.route({
|
|
1745
2235
|
path: "/v1/teams",
|
|
1746
2236
|
method: "GET",
|
|
1747
2237
|
summary: "List teams",
|
|
@@ -1754,7 +2244,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1754
2244
|
createdAt: z.coerce.date(),
|
|
1755
2245
|
hasStripeAccount: z.boolean()
|
|
1756
2246
|
})));
|
|
1757
|
-
const
|
|
2247
|
+
const getTeamUsageContractV1 = base.route({
|
|
2248
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2249
|
+
method: "GET",
|
|
2250
|
+
summary: "Get team usage",
|
|
2251
|
+
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.",
|
|
2252
|
+
tags: ["teams"],
|
|
2253
|
+
successDescription: "The current billing window usage"
|
|
2254
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2255
|
+
teamId: z.string(),
|
|
2256
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2257
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2258
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2259
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2260
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2261
|
+
}));
|
|
2262
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1758
2263
|
path: "/v1/tunnels/ticket",
|
|
1759
2264
|
method: "GET",
|
|
1760
2265
|
summary: "Get a tunnel ticket",
|
|
@@ -1766,16 +2271,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1766
2271
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1767
2272
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1768
2273
|
}));
|
|
1769
|
-
const publishServerContractV1 =
|
|
2274
|
+
const publishServerContractV1 = base.route({
|
|
1770
2275
|
path: "/v1/distribution/publish",
|
|
1771
2276
|
method: "POST",
|
|
1772
2277
|
summary: "Publish a server to the MCP registry",
|
|
1773
2278
|
tags: ["distribution"],
|
|
1774
2279
|
successDescription: "The server has been published successfully"
|
|
1775
|
-
}).errors({
|
|
1776
|
-
NOT_FOUND: {},
|
|
1777
|
-
BAD_REQUEST: {}
|
|
1778
|
-
}).input(z.object({
|
|
2280
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1779
2281
|
projectId: z.string(),
|
|
1780
2282
|
domain: z.string(),
|
|
1781
2283
|
title: z.string().min(1).max(100),
|
|
@@ -1784,17 +2286,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1784
2286
|
iconSrc: z.url().max(255).optional(),
|
|
1785
2287
|
dryRun: z.boolean().optional()
|
|
1786
2288
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1787
|
-
const getServerInfoContractV1 =
|
|
2289
|
+
const getServerInfoContractV1 = base.route({
|
|
1788
2290
|
path: "/v1/distribution/get",
|
|
1789
2291
|
method: "GET",
|
|
1790
2292
|
summary: "Get server info",
|
|
1791
2293
|
description: "Get info about a server",
|
|
1792
2294
|
tags: ["distribution"],
|
|
1793
2295
|
successDescription: "The server info"
|
|
1794
|
-
}).errors({
|
|
1795
|
-
NOT_FOUND: {},
|
|
1796
|
-
BAD_REQUEST: {}
|
|
1797
|
-
}).input(z.object({
|
|
2296
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1798
2297
|
projectId: z.string(),
|
|
1799
2298
|
domain: z.string()
|
|
1800
2299
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1813,7 +2312,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1813
2312
|
isPlaygroundEnabled: z.boolean(),
|
|
1814
2313
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1815
2314
|
});
|
|
1816
|
-
const getPlaygroundContractV1 =
|
|
2315
|
+
const getPlaygroundContractV1 = base.route({
|
|
1817
2316
|
path: "/v1/environments/{environmentId}/playground",
|
|
1818
2317
|
method: "GET",
|
|
1819
2318
|
summary: "Get playground configuration",
|
|
@@ -1821,17 +2320,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1821
2320
|
tags: ["environments"],
|
|
1822
2321
|
successDescription: "The playground configuration"
|
|
1823
2322
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1824
|
-
const upsertPlaygroundContractV1 =
|
|
2323
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1825
2324
|
path: "/v1/environments/{environmentId}/playground",
|
|
1826
2325
|
method: "PUT",
|
|
1827
2326
|
summary: "Update playground configuration",
|
|
1828
2327
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1829
2328
|
tags: ["environments"],
|
|
1830
2329
|
successDescription: "The updated playground configuration"
|
|
1831
|
-
}).errors({
|
|
1832
|
-
NOT_FOUND: {},
|
|
1833
|
-
BAD_REQUEST: {}
|
|
1834
|
-
}).input(z.object({
|
|
2330
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1835
2331
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1836
2332
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1837
2333
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1839,7 +2335,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1839
2335
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1840
2336
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1841
2337
|
})).output(playgroundOutputSchema);
|
|
1842
|
-
const createBeaconContractV1 =
|
|
2338
|
+
const createBeaconContractV1 = base.route({
|
|
1843
2339
|
path: "/v1/beacon/audits",
|
|
1844
2340
|
method: "POST",
|
|
1845
2341
|
summary: "Create a beacon audit",
|
|
@@ -1848,7 +2344,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1848
2344
|
successDescription: "The audit has been created"
|
|
1849
2345
|
}).errors({
|
|
1850
2346
|
NOT_FOUND: {},
|
|
1851
|
-
BAD_REQUEST: {},
|
|
1852
2347
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1853
2348
|
}).input(z.object({
|
|
1854
2349
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1856,7 +2351,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1856
2351
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1857
2352
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1858
2353
|
})).output(z.object({ id: z.string() }));
|
|
1859
|
-
const getBeaconContractV1 =
|
|
2354
|
+
const getBeaconContractV1 = base.route({
|
|
1860
2355
|
path: "/v1/beacon/audits/{auditId}",
|
|
1861
2356
|
method: "GET",
|
|
1862
2357
|
summary: "Get a beacon audit",
|
|
@@ -1871,9 +2366,73 @@ const getBeaconContractV1 = oc.route({
|
|
|
1871
2366
|
createdAt: z.coerce.date(),
|
|
1872
2367
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1873
2368
|
}));
|
|
2369
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2370
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2371
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2372
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2373
|
+
const createSubmissionContractV1 = base.route({
|
|
2374
|
+
path: "/v1/submissions",
|
|
2375
|
+
method: "POST",
|
|
2376
|
+
summary: "Create a submission package",
|
|
2377
|
+
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.",
|
|
2378
|
+
tags: ["submissions"],
|
|
2379
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2380
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2381
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2382
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2383
|
+
})).output(submissionSchema);
|
|
2384
|
+
const listSubmissionsContractV1 = base.route({
|
|
2385
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2386
|
+
method: "GET",
|
|
2387
|
+
summary: "List submission packages",
|
|
2388
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2389
|
+
tags: ["submissions"],
|
|
2390
|
+
successDescription: "The list of submission packages"
|
|
2391
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2392
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2393
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2394
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2395
|
+
})).output(z.array(submissionSchema));
|
|
2396
|
+
const getSubmissionContractV1 = base.route({
|
|
2397
|
+
path: "/v1/submissions/{submissionId}",
|
|
2398
|
+
method: "GET",
|
|
2399
|
+
summary: "Get a submission package",
|
|
2400
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2401
|
+
tags: ["submissions"],
|
|
2402
|
+
successDescription: "The submission package"
|
|
2403
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2404
|
+
const updateSubmissionContractV1 = base.route({
|
|
2405
|
+
path: "/v1/submissions/{submissionId}",
|
|
2406
|
+
method: "PUT",
|
|
2407
|
+
summary: "Update a submission package",
|
|
2408
|
+
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.",
|
|
2409
|
+
tags: ["submissions"],
|
|
2410
|
+
successDescription: "The updated submission package"
|
|
2411
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2412
|
+
submissionId: submissionIdSchema,
|
|
2413
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2414
|
+
formData: claudeSubmissionUpdateSchema
|
|
2415
|
+
}), z.object({
|
|
2416
|
+
submissionId: submissionIdSchema,
|
|
2417
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2418
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2419
|
+
})])).output(submissionSchema);
|
|
1874
2420
|
const contract = {
|
|
1875
|
-
teams: {
|
|
2421
|
+
teams: {
|
|
2422
|
+
list: { v1: listTeamsContractV1 },
|
|
2423
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2424
|
+
},
|
|
1876
2425
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2426
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2427
|
+
intentCategories: {
|
|
2428
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2429
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2430
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2431
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2432
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2433
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2434
|
+
},
|
|
2435
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1877
2436
|
deployments: {
|
|
1878
2437
|
list: { v1: listDeploymentsContractV1 },
|
|
1879
2438
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1883,6 +2442,7 @@ const contract = {
|
|
|
1883
2442
|
environments: {
|
|
1884
2443
|
create: { v1: createEnvironmentContractV1 },
|
|
1885
2444
|
get: { v1: getEnvironmentContractV1 },
|
|
2445
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1886
2446
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1887
2447
|
getLogs: { v1: getLogsContractV1 },
|
|
1888
2448
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1912,7 +2472,39 @@ const contract = {
|
|
|
1912
2472
|
beacon: {
|
|
1913
2473
|
create: { v1: createBeaconContractV1 },
|
|
1914
2474
|
get: { v1: getBeaconContractV1 }
|
|
2475
|
+
},
|
|
2476
|
+
submissions: {
|
|
2477
|
+
create: { v1: createSubmissionContractV1 },
|
|
2478
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2479
|
+
get: { v1: getSubmissionContractV1 },
|
|
2480
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2481
|
+
}
|
|
2482
|
+
};
|
|
2483
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2484
|
+
const contractForDocs = {
|
|
2485
|
+
...contract,
|
|
2486
|
+
deployments: deploymentsForDocs
|
|
2487
|
+
};
|
|
2488
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2489
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2490
|
+
info: {
|
|
2491
|
+
title: "Alpic API",
|
|
2492
|
+
version: "1.0.0"
|
|
2493
|
+
},
|
|
2494
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2495
|
+
security: [{ bearerAuth: [] }],
|
|
2496
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2497
|
+
type: "http",
|
|
2498
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2499
|
+
scheme: "bearer"
|
|
2500
|
+
} } },
|
|
2501
|
+
commonSchemas: {
|
|
2502
|
+
Submission: { schema: submissionSchema },
|
|
2503
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2504
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2505
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2506
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
1915
2507
|
}
|
|
1916
2508
|
};
|
|
1917
2509
|
//#endregion
|
|
1918
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2510
|
+
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 };
|