@alpic-ai/api 0.0.0-dev.ge5a7a49 → 0.0.0-dev.ge5dbc11
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 +6298 -97
- package/dist/index.mjs +892 -218
- package/package.json +26 -10
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
|
*/
|
|
@@ -169,11 +169,22 @@ z$1.object({
|
|
|
169
169
|
token: z$1.string(),
|
|
170
170
|
token_type_hint: z$1.string().optional()
|
|
171
171
|
}).strip();
|
|
172
|
-
|
|
172
|
+
//#endregion
|
|
173
|
+
//#region ../domains/dist/index.mjs
|
|
174
|
+
const AI_PLATFORMS = ["chatgpt", "claudeai"];
|
|
175
|
+
const platformSchema = z.enum(AI_PLATFORMS);
|
|
173
176
|
const PLATFORM_LABELS = {
|
|
174
177
|
chatgpt: "ChatGPT",
|
|
175
178
|
claudeai: "Claude.ai"
|
|
176
179
|
};
|
|
180
|
+
const WAF_PLATFORMS = [
|
|
181
|
+
"akamai",
|
|
182
|
+
"cato",
|
|
183
|
+
"cloudflare",
|
|
184
|
+
"fastly"
|
|
185
|
+
];
|
|
186
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
187
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
177
188
|
const auditStatusSchema = z.enum([
|
|
178
189
|
"pending",
|
|
179
190
|
"partial",
|
|
@@ -246,6 +257,25 @@ z.object({
|
|
|
246
257
|
clientSecret: z.string(),
|
|
247
258
|
clientScopes: z.array(z.string())
|
|
248
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
|
+
});
|
|
249
279
|
const deploymentStatusSchema$1 = z.enum([
|
|
250
280
|
"ongoing",
|
|
251
281
|
"deployed",
|
|
@@ -273,34 +303,51 @@ const deploymentSummarySchema = z.object({
|
|
|
273
303
|
createdAt: z.coerce.date(),
|
|
274
304
|
updatedAt: z.coerce.date()
|
|
275
305
|
});
|
|
276
|
-
/**
|
|
277
|
-
* Public environment
|
|
278
|
-
*
|
|
279
|
-
* No OAuth metadata exposed.
|
|
280
|
-
*/
|
|
306
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
281
307
|
const publicEnvironmentSchema = z.object({
|
|
308
|
+
allowsAnonymous: z.literal(true),
|
|
309
|
+
oAuthMetadata: z.strictObject({})
|
|
310
|
+
});
|
|
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. */
|
|
312
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
313
|
+
allowsAnonymous: z.boolean(),
|
|
314
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
315
|
+
scope: z.string().optional()
|
|
316
|
+
});
|
|
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. */
|
|
318
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
319
|
+
allowsAnonymous: z.boolean(),
|
|
320
|
+
oAuthMetadata: z.object({
|
|
321
|
+
externalAuthorizationServerUrl: z.url(),
|
|
322
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
323
|
+
}),
|
|
324
|
+
scope: z.string().optional()
|
|
325
|
+
});
|
|
326
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
327
|
+
const standaloneEnvironmentSchema = z.object({
|
|
328
|
+
allowsAnonymous: z.boolean(),
|
|
329
|
+
oAuthMetadata: z.object({
|
|
330
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
331
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
332
|
+
}),
|
|
333
|
+
scope: z.string().optional()
|
|
334
|
+
});
|
|
335
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
336
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
337
|
+
allowsAnonymous: z.literal(false),
|
|
338
|
+
oAuthMetadata: z.strictObject({}),
|
|
339
|
+
scope: z.string().optional()
|
|
340
|
+
});
|
|
341
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
282
342
|
isPublic: z.literal(true),
|
|
283
343
|
oAuthMetadata: z.undefined().optional()
|
|
284
344
|
});
|
|
285
|
-
|
|
286
|
-
* Protected environment with an external resource metadata URL
|
|
287
|
-
*
|
|
288
|
-
* An external resource metadata URL is returned in the WWW-Authenticate header during the first 401 response.
|
|
289
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
290
|
-
*/
|
|
291
|
-
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
345
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
292
346
|
isPublic: z.literal(false),
|
|
293
347
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
348
|
scope: z.string().optional()
|
|
295
349
|
});
|
|
296
|
-
|
|
297
|
-
* Protected environment with an external authorization server URL
|
|
298
|
-
*
|
|
299
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
300
|
-
* An external authorization server URL is returned when requesting the endpoint.
|
|
301
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
302
|
-
*/
|
|
303
|
-
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
350
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
351
|
isPublic: z.literal(false),
|
|
305
352
|
oAuthMetadata: z.object({
|
|
306
353
|
externalAuthorizationServerUrl: z.url(),
|
|
@@ -308,13 +355,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
308
355
|
}),
|
|
309
356
|
scope: z.string().optional()
|
|
310
357
|
});
|
|
311
|
-
|
|
312
|
-
* Standalone protected environment
|
|
313
|
-
*
|
|
314
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
315
|
-
* The server itself exposes the /.well-known/oauth-authorization-server endpoint.
|
|
316
|
-
*/
|
|
317
|
-
const standaloneEnvironmentSchema = z.object({
|
|
358
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
318
359
|
isPublic: z.literal(false),
|
|
319
360
|
oAuthMetadata: z.object({
|
|
320
361
|
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
@@ -322,14 +363,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
322
363
|
}),
|
|
323
364
|
scope: z.string().optional()
|
|
324
365
|
});
|
|
325
|
-
|
|
326
|
-
* Protected environment without OAuth discovery
|
|
327
|
-
*
|
|
328
|
-
* The server enforces authentication but exposes no OAuth discovery metadata.
|
|
329
|
-
* Neither /.well-known/oauth-protected-resource nor /.well-known/oauth-authorization-server
|
|
330
|
-
* are advertised. Clients must obtain credentials out-of-band.
|
|
331
|
-
*/
|
|
332
|
-
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
366
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
367
|
isPublic: z.literal(false),
|
|
334
368
|
oAuthMetadata: z.strictObject({}),
|
|
335
369
|
scope: z.string().optional()
|
|
@@ -339,9 +373,19 @@ z.union([
|
|
|
339
373
|
externalResourceMetadataEnvironmentSchema,
|
|
340
374
|
externalAuthorizationServerEnvironmentSchema,
|
|
341
375
|
standaloneEnvironmentSchema,
|
|
342
|
-
protectedWithoutDiscoveryEnvironmentSchema
|
|
376
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
377
|
+
legacyPublicEnvironmentSchema,
|
|
378
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
379
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
380
|
+
legacyStandaloneEnvironmentSchema,
|
|
381
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
382
|
+
]);
|
|
383
|
+
const playgroundModelSchema = z.enum([
|
|
384
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
385
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
386
|
+
"openai.gpt-5.4",
|
|
387
|
+
"openai.gpt-5.5"
|
|
343
388
|
]);
|
|
344
|
-
const allowedPlatformSchema = platformSchema;
|
|
345
389
|
const environmentDomainSchema = z.object({
|
|
346
390
|
name: z.string(),
|
|
347
391
|
status: z.enum([
|
|
@@ -361,6 +405,7 @@ const environmentSchema$1 = z.object({
|
|
|
361
405
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
362
406
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
363
407
|
isPlaygroundEnabled: z.boolean(),
|
|
408
|
+
playgroundModel: playgroundModelSchema,
|
|
364
409
|
isIpWhitelistEnabled: z.boolean(),
|
|
365
410
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
366
411
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -373,14 +418,18 @@ z.object({
|
|
|
373
418
|
sessionReplayEnabled: z.boolean(),
|
|
374
419
|
collectRequestPayload: z.boolean(),
|
|
375
420
|
collectResponsePayload: z.boolean(),
|
|
376
|
-
collectErrorMessage: z.boolean()
|
|
421
|
+
collectErrorMessage: z.boolean(),
|
|
422
|
+
collectUserData: z.boolean(),
|
|
423
|
+
identityTraitKey: z.string().min(1).max(200).nullable(),
|
|
424
|
+
leadEventName: z.string().min(1).max(200).nullable()
|
|
377
425
|
});
|
|
378
|
-
z.object({
|
|
426
|
+
const feedbackSchema = z.object({
|
|
379
427
|
id: z.string(),
|
|
380
428
|
createdAt: z.coerce.date(),
|
|
381
429
|
environmentId: z.string(),
|
|
382
430
|
content: z.string(),
|
|
383
|
-
source: z.enum(["model", "user"])
|
|
431
|
+
source: z.enum(["model", "user"]),
|
|
432
|
+
clientName: z.string().nullable()
|
|
384
433
|
});
|
|
385
434
|
z.object({
|
|
386
435
|
content: z.string(),
|
|
@@ -396,7 +445,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
396
445
|
"pink",
|
|
397
446
|
"gray"
|
|
398
447
|
]);
|
|
399
|
-
intentCategoryColorSchema.options;
|
|
448
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
400
449
|
const intentCategorySchema = z.object({
|
|
401
450
|
id: z.string(),
|
|
402
451
|
createdAt: z.coerce.date(),
|
|
@@ -404,7 +453,7 @@ const intentCategorySchema = z.object({
|
|
|
404
453
|
name: z.string(),
|
|
405
454
|
color: intentCategoryColorSchema
|
|
406
455
|
});
|
|
407
|
-
z.object({
|
|
456
|
+
const intentCategorySummarySchema = z.object({
|
|
408
457
|
id: z.string(),
|
|
409
458
|
name: z.string(),
|
|
410
459
|
color: intentCategoryColorSchema,
|
|
@@ -416,6 +465,7 @@ z.object({
|
|
|
416
465
|
environmentId: z.string(),
|
|
417
466
|
toolName: z.string(),
|
|
418
467
|
message: z.string(),
|
|
468
|
+
clientName: z.string().nullable(),
|
|
419
469
|
categories: z.array(intentCategorySchema)
|
|
420
470
|
});
|
|
421
471
|
const signalCategorySchema = z.object({
|
|
@@ -474,12 +524,262 @@ z.object({
|
|
|
474
524
|
createdAt: z.coerce.date(),
|
|
475
525
|
updatedAt: z.coerce.date()
|
|
476
526
|
});
|
|
527
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
528
|
+
type: z.literal("mcp_request"),
|
|
529
|
+
method: z.string()
|
|
530
|
+
});
|
|
531
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
532
|
+
type: z.literal("mcp_error"),
|
|
533
|
+
method: z.string(),
|
|
534
|
+
error: z.string()
|
|
535
|
+
});
|
|
536
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
477
537
|
z.enum([
|
|
478
538
|
"INFO",
|
|
479
539
|
"WARNING",
|
|
480
540
|
"DEBUG",
|
|
481
541
|
"ERROR"
|
|
482
542
|
]);
|
|
543
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
544
|
+
const MCP_CLIENT_GROUPS = [
|
|
545
|
+
{
|
|
546
|
+
id: "claude_code",
|
|
547
|
+
label: "Claude Code",
|
|
548
|
+
vendor: "anthropic",
|
|
549
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
550
|
+
},
|
|
551
|
+
{
|
|
552
|
+
id: "claude",
|
|
553
|
+
label: "Claude",
|
|
554
|
+
vendor: "anthropic",
|
|
555
|
+
rawNames: [
|
|
556
|
+
"Anthropic/ClaudeAI",
|
|
557
|
+
"claude-ai",
|
|
558
|
+
"claude",
|
|
559
|
+
"Claude",
|
|
560
|
+
"claude-desktop",
|
|
561
|
+
"claude-desktop-3p"
|
|
562
|
+
]
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
id: "claude_mobile",
|
|
566
|
+
label: "Claude mobile",
|
|
567
|
+
vendor: "anthropic",
|
|
568
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
569
|
+
},
|
|
570
|
+
{
|
|
571
|
+
id: "claude_cowork",
|
|
572
|
+
label: "Claude Cowork",
|
|
573
|
+
vendor: "anthropic",
|
|
574
|
+
rawNames: ["Anthropic/Cowork"]
|
|
575
|
+
},
|
|
576
|
+
{
|
|
577
|
+
id: "claude_toolbox",
|
|
578
|
+
label: "Claude Toolbox",
|
|
579
|
+
vendor: "anthropic",
|
|
580
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
581
|
+
},
|
|
582
|
+
{
|
|
583
|
+
id: "anthropic_api",
|
|
584
|
+
label: "Anthropic API",
|
|
585
|
+
vendor: "anthropic",
|
|
586
|
+
rawNames: ["Anthropic/API"]
|
|
587
|
+
},
|
|
588
|
+
{
|
|
589
|
+
id: "anthropic_connector_refresh",
|
|
590
|
+
label: "Anthropic (connector refresh)",
|
|
591
|
+
vendor: "anthropic",
|
|
592
|
+
rawNames: ["Anthropic"]
|
|
593
|
+
},
|
|
594
|
+
{
|
|
595
|
+
id: "codex",
|
|
596
|
+
label: "Codex",
|
|
597
|
+
vendor: "openai",
|
|
598
|
+
rawNames: [
|
|
599
|
+
"codex-mcp-client",
|
|
600
|
+
"codex",
|
|
601
|
+
"Codex",
|
|
602
|
+
"codex-cli",
|
|
603
|
+
"openai-mcp (Codex)"
|
|
604
|
+
]
|
|
605
|
+
},
|
|
606
|
+
{
|
|
607
|
+
id: "chatgpt",
|
|
608
|
+
label: "ChatGPT",
|
|
609
|
+
vendor: "openai",
|
|
610
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
611
|
+
},
|
|
612
|
+
{
|
|
613
|
+
id: "openai_responses_api",
|
|
614
|
+
label: "OpenAI Responses API",
|
|
615
|
+
vendor: "openai",
|
|
616
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
617
|
+
},
|
|
618
|
+
{
|
|
619
|
+
id: "openai_agent_builder",
|
|
620
|
+
label: "OpenAI Agent Builder",
|
|
621
|
+
vendor: "openai",
|
|
622
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
623
|
+
},
|
|
624
|
+
{
|
|
625
|
+
id: "openai_other",
|
|
626
|
+
label: "OpenAI Other",
|
|
627
|
+
vendor: "openai",
|
|
628
|
+
rawNames: ["openai-mcp"]
|
|
629
|
+
},
|
|
630
|
+
{
|
|
631
|
+
id: "cursor",
|
|
632
|
+
label: "Cursor",
|
|
633
|
+
vendor: "cursor",
|
|
634
|
+
rawNames: [
|
|
635
|
+
"cursor-vscode",
|
|
636
|
+
"Cursor",
|
|
637
|
+
"cursor"
|
|
638
|
+
]
|
|
639
|
+
},
|
|
640
|
+
{
|
|
641
|
+
id: "cline",
|
|
642
|
+
label: "Cline",
|
|
643
|
+
vendor: "cline",
|
|
644
|
+
rawNames: [
|
|
645
|
+
"Cline",
|
|
646
|
+
"cline",
|
|
647
|
+
"@cline/core"
|
|
648
|
+
]
|
|
649
|
+
},
|
|
650
|
+
{
|
|
651
|
+
id: "github_copilot",
|
|
652
|
+
label: "GitHub Copilot",
|
|
653
|
+
vendor: "githubCopilot",
|
|
654
|
+
rawNames: [
|
|
655
|
+
"Copilot",
|
|
656
|
+
"github-copilot-developer",
|
|
657
|
+
"Copilot MCP Gateway",
|
|
658
|
+
"Xcode/copilot-xcode"
|
|
659
|
+
]
|
|
660
|
+
},
|
|
661
|
+
{
|
|
662
|
+
id: "gemini_cli",
|
|
663
|
+
label: "Gemini CLI",
|
|
664
|
+
vendor: "google",
|
|
665
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
666
|
+
},
|
|
667
|
+
{
|
|
668
|
+
id: "antigravity",
|
|
669
|
+
label: "Antigravity",
|
|
670
|
+
vendor: "google",
|
|
671
|
+
rawNames: ["antigravity-client"]
|
|
672
|
+
},
|
|
673
|
+
{
|
|
674
|
+
id: "gemini",
|
|
675
|
+
label: "Gemini",
|
|
676
|
+
vendor: "google",
|
|
677
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
678
|
+
},
|
|
679
|
+
{
|
|
680
|
+
id: "windsurf",
|
|
681
|
+
label: "Windsurf",
|
|
682
|
+
vendor: "windsurf",
|
|
683
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
684
|
+
},
|
|
685
|
+
{
|
|
686
|
+
id: "mistral",
|
|
687
|
+
label: "Mistral / Le Chat",
|
|
688
|
+
vendor: "mistral",
|
|
689
|
+
rawNames: ["Mistral"],
|
|
690
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
691
|
+
},
|
|
692
|
+
{
|
|
693
|
+
id: "n8n",
|
|
694
|
+
label: "n8n",
|
|
695
|
+
vendor: "n8n",
|
|
696
|
+
rawNames: [
|
|
697
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
698
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
699
|
+
"n8n"
|
|
700
|
+
]
|
|
701
|
+
},
|
|
702
|
+
{
|
|
703
|
+
id: "alpic_playground",
|
|
704
|
+
label: "Alpic Playground",
|
|
705
|
+
vendor: "alpic",
|
|
706
|
+
rawNames: ["alpic-playground", "playground"]
|
|
707
|
+
},
|
|
708
|
+
{
|
|
709
|
+
id: "opencode",
|
|
710
|
+
label: "opencode",
|
|
711
|
+
vendor: "opencode",
|
|
712
|
+
rawNames: ["opencode"]
|
|
713
|
+
},
|
|
714
|
+
{
|
|
715
|
+
id: "zed",
|
|
716
|
+
label: "Zed",
|
|
717
|
+
vendor: "zed",
|
|
718
|
+
rawNames: ["Zed", "zed"]
|
|
719
|
+
},
|
|
720
|
+
{
|
|
721
|
+
id: "zapier",
|
|
722
|
+
label: "Zapier",
|
|
723
|
+
vendor: "zapier",
|
|
724
|
+
rawNames: ["Zapier", "zapier"]
|
|
725
|
+
},
|
|
726
|
+
{
|
|
727
|
+
id: "make",
|
|
728
|
+
label: "Make",
|
|
729
|
+
vendor: "make",
|
|
730
|
+
rawNames: ["Make", "make"]
|
|
731
|
+
},
|
|
732
|
+
{
|
|
733
|
+
id: "librechat",
|
|
734
|
+
label: "LibreChat",
|
|
735
|
+
vendor: "mcp",
|
|
736
|
+
rawNames: ["LibreChat", "librechat"]
|
|
737
|
+
},
|
|
738
|
+
{
|
|
739
|
+
id: "jan",
|
|
740
|
+
label: "Jan",
|
|
741
|
+
vendor: "mcp",
|
|
742
|
+
rawNames: ["Jan", "jan"]
|
|
743
|
+
},
|
|
744
|
+
{
|
|
745
|
+
id: "goose",
|
|
746
|
+
label: "goose",
|
|
747
|
+
vendor: "mcp",
|
|
748
|
+
rawNames: ["goose", "Goose"]
|
|
749
|
+
},
|
|
750
|
+
{
|
|
751
|
+
id: "mcphost",
|
|
752
|
+
label: "mcphost",
|
|
753
|
+
vendor: "mcp",
|
|
754
|
+
rawNames: ["mcphost"]
|
|
755
|
+
},
|
|
756
|
+
{
|
|
757
|
+
id: "mcporter",
|
|
758
|
+
label: "mcporter",
|
|
759
|
+
vendor: "mcp",
|
|
760
|
+
rawNames: ["mcporter"]
|
|
761
|
+
},
|
|
762
|
+
{
|
|
763
|
+
id: "rmcp",
|
|
764
|
+
label: "rmcp",
|
|
765
|
+
vendor: "mcp",
|
|
766
|
+
rawNames: ["rmcp"]
|
|
767
|
+
},
|
|
768
|
+
{
|
|
769
|
+
id: "unnamed_client",
|
|
770
|
+
label: "Unnamed client",
|
|
771
|
+
vendor: "mcp",
|
|
772
|
+
rawNames: [
|
|
773
|
+
"mcp",
|
|
774
|
+
"unknown",
|
|
775
|
+
""
|
|
776
|
+
]
|
|
777
|
+
}
|
|
778
|
+
];
|
|
779
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
780
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
781
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
782
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
483
783
|
const runtimeSchema = z.enum([
|
|
484
784
|
"python3.13",
|
|
485
785
|
"python3.14",
|
|
@@ -508,6 +808,16 @@ z.object({
|
|
|
508
808
|
environments: z.array(environmentWithDomainsSchema),
|
|
509
809
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
510
810
|
});
|
|
811
|
+
const domainFailureReasonSchema = z.enum([
|
|
812
|
+
"caa",
|
|
813
|
+
"dns",
|
|
814
|
+
"invalid_domain",
|
|
815
|
+
"other"
|
|
816
|
+
]);
|
|
817
|
+
const projectDomainMappingSchema = z.object({
|
|
818
|
+
pathPrefix: z.string(),
|
|
819
|
+
environment: environmentSchema$1
|
|
820
|
+
});
|
|
511
821
|
z.object({
|
|
512
822
|
name: z.string(),
|
|
513
823
|
createdAt: z.coerce.date(),
|
|
@@ -516,7 +826,9 @@ z.object({
|
|
|
516
826
|
"deployed",
|
|
517
827
|
"failed"
|
|
518
828
|
]),
|
|
519
|
-
|
|
829
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
830
|
+
environment: environmentSchema$1,
|
|
831
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
520
832
|
});
|
|
521
833
|
const serverFieldsSchema$1 = z.object({
|
|
522
834
|
$schema: z.string(),
|
|
@@ -545,15 +857,7 @@ z.object({
|
|
|
545
857
|
serverFields: serverFieldsSchema$1,
|
|
546
858
|
source: z.enum(["registry", "defaults"])
|
|
547
859
|
});
|
|
548
|
-
/**
|
|
549
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
550
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
551
|
-
*
|
|
552
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
553
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
554
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
555
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
556
|
-
*/
|
|
860
|
+
/** 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. */
|
|
557
861
|
const clampStringField = (field) => {
|
|
558
862
|
const max = field.maxLength;
|
|
559
863
|
if (max === null) return field;
|
|
@@ -561,6 +865,10 @@ const clampStringField = (field) => {
|
|
|
561
865
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
562
866
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
563
867
|
};
|
|
868
|
+
const unboundedArrayField = (field) => {
|
|
869
|
+
const unbounded = z.array(field.element);
|
|
870
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
871
|
+
};
|
|
564
872
|
const toolDefinitionSchema = z.object({
|
|
565
873
|
name: z.string(),
|
|
566
874
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -573,15 +881,27 @@ const toolDefinitionSchema = z.object({
|
|
|
573
881
|
}).optional()
|
|
574
882
|
});
|
|
575
883
|
const positiveTestCaseSchema = z.object({
|
|
576
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
577
|
-
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."),
|
|
884
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
885
|
+
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."),
|
|
578
886
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
579
887
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
580
|
-
}).
|
|
888
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
889
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
890
|
+
scenario: z.string().optional(),
|
|
891
|
+
userPrompt: z.string().optional()
|
|
892
|
+
});
|
|
893
|
+
const blankPositiveTestCase = () => ({
|
|
894
|
+
scenario: "",
|
|
895
|
+
userPrompt: "",
|
|
896
|
+
toolTriggered: "",
|
|
897
|
+
expectedOutput: ""
|
|
898
|
+
});
|
|
899
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
581
900
|
const screenshotEntrySchema = z.object({
|
|
582
901
|
prompt: z.string(),
|
|
583
|
-
url: z.url()
|
|
902
|
+
url: z.url()
|
|
584
903
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
904
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
585
905
|
/** Accepts either a valid email or URL. */
|
|
586
906
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
587
907
|
/** A URL field whose error spells out that the scheme is required. */
|
|
@@ -889,20 +1209,25 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
889
1209
|
"zh-TW"
|
|
890
1210
|
]);
|
|
891
1211
|
const negativeTestCaseSchema = z.object({
|
|
892
|
-
scenario: z.string(),
|
|
893
|
-
userPrompt: z.string()
|
|
894
|
-
}).
|
|
1212
|
+
scenario: z.string().min(1),
|
|
1213
|
+
userPrompt: z.string().min(1)
|
|
1214
|
+
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1215
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1216
|
+
scenario: z.string().optional(),
|
|
1217
|
+
userPrompt: z.string().optional()
|
|
1218
|
+
});
|
|
1219
|
+
const blankNegativeTestCase = () => ({
|
|
1220
|
+
scenario: "",
|
|
1221
|
+
userPrompt: ""
|
|
1222
|
+
});
|
|
1223
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
895
1224
|
const chatgptToolJustificationSchema = z.object({
|
|
896
1225
|
toolName: z.string(),
|
|
897
1226
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
898
1227
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
899
1228
|
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.\"")
|
|
900
1229
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
901
|
-
/**
|
|
902
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
903
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
904
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
905
|
-
*/
|
|
1230
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
906
1231
|
const chatgptTaglineSchema = z.string().max(30);
|
|
907
1232
|
const chatgptDescriptionSchema = z.string();
|
|
908
1233
|
const chatgptTranslationSchema = z.object({
|
|
@@ -911,10 +1236,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
911
1236
|
description: chatgptDescriptionSchema
|
|
912
1237
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
913
1238
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
914
|
-
/**
|
|
915
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
916
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
917
|
-
*/
|
|
1239
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
918
1240
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
919
1241
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
920
1242
|
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."),
|
|
@@ -933,28 +1255,52 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
933
1255
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
934
1256
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
935
1257
|
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."),
|
|
936
|
-
|
|
937
|
-
|
|
1258
|
+
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."),
|
|
1259
|
+
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."),
|
|
1260
|
+
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."),
|
|
938
1261
|
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."),
|
|
939
1262
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
940
1263
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
941
1264
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
942
1265
|
});
|
|
943
|
-
chatgptSubmissionFormDataSchema.
|
|
1266
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1267
|
+
tagline: z.string().optional(),
|
|
1268
|
+
companyUrl: z.string().optional(),
|
|
1269
|
+
supportChannel: z.string().optional(),
|
|
1270
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1271
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1272
|
+
demoRecordingUrl: z.string().optional(),
|
|
1273
|
+
serverUrl: z.string().optional(),
|
|
1274
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1275
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1276
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1277
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1278
|
+
});
|
|
1279
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1280
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
944
1281
|
appName: true,
|
|
945
1282
|
developerName: true,
|
|
946
1283
|
serverUrl: true,
|
|
947
1284
|
tools: true,
|
|
1285
|
+
skills: true,
|
|
948
1286
|
authentication: true
|
|
949
1287
|
});
|
|
950
|
-
|
|
1288
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1289
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
951
1290
|
tagline: true,
|
|
952
1291
|
description: true,
|
|
953
1292
|
category: true,
|
|
954
1293
|
testCases: true,
|
|
955
1294
|
negativeTestCases: true,
|
|
956
1295
|
toolJustifications: true
|
|
957
|
-
}).extend({
|
|
1296
|
+
}).extend({
|
|
1297
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1298
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1299
|
+
}).extend({
|
|
1300
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1301
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1302
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1303
|
+
});
|
|
958
1304
|
const claudeCategorySchema = z.enum([
|
|
959
1305
|
"Productivity",
|
|
960
1306
|
"Communication",
|
|
@@ -1000,11 +1346,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1000
1346
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1001
1347
|
"Public documentation for this connector will be live by the publish date."
|
|
1002
1348
|
]);
|
|
1003
|
-
/**
|
|
1004
|
-
* Field order mirrors the claude.ai directory submission wizard
|
|
1005
|
-
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1006
|
-
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1007
|
-
*/
|
|
1349
|
+
/** 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. */
|
|
1008
1350
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1009
1351
|
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
|
|
1010
1352
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1018,8 +1360,8 @@ phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects i
|
|
|
1018
1360
|
description: z.string().max(2e3).describe(`A description of what your connector does and its key features, shown on the connector's detail page in
|
|
1019
1361
|
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1020
1362
|
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1021
|
-
iconUrl: z.url().optional().describe(`Optional custom icon
|
|
1022
|
-
|
|
1363
|
+
iconUrl: z.url().optional().describe(`Optional custom icon for the directory listing — a square SVG. By default the favicon from your MCP URL is used
|
|
1364
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1023
1365
|
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1024
1366
|
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1025
1367
|
by your publish date.`),
|
|
@@ -1027,6 +1369,8 @@ by your publish date.`),
|
|
|
1027
1369
|
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1028
1370
|
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1029
1371
|
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1372
|
+
screenshots: z.array(screenshotEntrySchema).optional().describe(`Carousel images shown on your connector's directory page (PNG). Each is paired with the user prompt that produced
|
|
1373
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1030
1374
|
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1031
1375
|
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1032
1376
|
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
@@ -1064,7 +1408,23 @@ fully populated account.`),
|
|
|
1064
1408
|
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1065
1409
|
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1066
1410
|
});
|
|
1067
|
-
claudeSubmissionFormDataSchema.
|
|
1411
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1412
|
+
serverUrl: z.string().optional(),
|
|
1413
|
+
name: z.string().optional(),
|
|
1414
|
+
slug: z.string().optional(),
|
|
1415
|
+
oneLiner: z.string().optional(),
|
|
1416
|
+
description: z.string().optional(),
|
|
1417
|
+
iconUrl: z.string().optional(),
|
|
1418
|
+
documentation: z.string().optional(),
|
|
1419
|
+
support: z.string().optional(),
|
|
1420
|
+
privacyPolicy: z.string().optional(),
|
|
1421
|
+
companyWebsite: z.string().optional(),
|
|
1422
|
+
primaryContactEmail: z.string().optional(),
|
|
1423
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1424
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1425
|
+
});
|
|
1426
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1427
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1068
1428
|
serverUrl: true,
|
|
1069
1429
|
name: true,
|
|
1070
1430
|
slug: true,
|
|
@@ -1079,39 +1439,93 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1079
1439
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1080
1440
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1081
1441
|
});
|
|
1082
|
-
/**
|
|
1083
|
-
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1084
|
-
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1085
|
-
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1086
|
-
* colocated with the Claude contract.
|
|
1087
|
-
*/
|
|
1442
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1088
1443
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1089
1444
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1090
1445
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1091
1446
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1092
1447
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1093
1448
|
});
|
|
1094
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1449
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1095
1450
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1096
1451
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1097
1452
|
});
|
|
1453
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1454
|
+
const byField = {};
|
|
1455
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1456
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1457
|
+
return byField;
|
|
1458
|
+
}
|
|
1459
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1460
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1461
|
+
"pass",
|
|
1462
|
+
"fail",
|
|
1463
|
+
"unverified"
|
|
1464
|
+
]);
|
|
1465
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1466
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1467
|
+
claudeai: ["privacyPolicy"]
|
|
1468
|
+
};
|
|
1469
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1470
|
+
const policyDisclosureSchema = z.enum([
|
|
1471
|
+
"dataCategories",
|
|
1472
|
+
"purposesOfUse",
|
|
1473
|
+
"recipients",
|
|
1474
|
+
"retention"
|
|
1475
|
+
]);
|
|
1476
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1477
|
+
field: verifiableUrlFieldSchema,
|
|
1478
|
+
url: z.string(),
|
|
1479
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1480
|
+
reason: z.string(),
|
|
1481
|
+
concerns: z.array(z.string()).optional(),
|
|
1482
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1483
|
+
});
|
|
1484
|
+
const urlVerificationSchema = z.object({
|
|
1485
|
+
verifiedAt: z.coerce.date(),
|
|
1486
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1487
|
+
});
|
|
1488
|
+
const pageKindSchema = z.enum([
|
|
1489
|
+
"expectedDocument",
|
|
1490
|
+
"errorPage",
|
|
1491
|
+
"loginWall",
|
|
1492
|
+
"parkedDomain",
|
|
1493
|
+
"comingSoon",
|
|
1494
|
+
"marketingPage",
|
|
1495
|
+
"unrelatedDocument"
|
|
1496
|
+
]);
|
|
1497
|
+
z.object({
|
|
1498
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1499
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1500
|
+
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.")
|
|
1501
|
+
});
|
|
1098
1502
|
const submissionMetaFieldsSchema = z.object({
|
|
1099
1503
|
id: z.string(),
|
|
1100
1504
|
environmentId: z.string(),
|
|
1101
1505
|
auditId: z.string().nullable(),
|
|
1506
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1102
1507
|
createdAt: z.coerce.date(),
|
|
1103
1508
|
updatedAt: z.coerce.date()
|
|
1104
1509
|
});
|
|
1105
1510
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1106
1511
|
platform: z.literal("claudeai"),
|
|
1107
|
-
formData:
|
|
1512
|
+
formData: claudeSubmissionDraftSchema,
|
|
1513
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1108
1514
|
});
|
|
1109
1515
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1110
1516
|
platform: z.literal("chatgpt"),
|
|
1111
|
-
formData:
|
|
1517
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1518
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1112
1519
|
});
|
|
1113
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1114
|
-
z.union([
|
|
1520
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1521
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1522
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1523
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1524
|
+
z.literal([
|
|
1525
|
+
100,
|
|
1526
|
+
75,
|
|
1527
|
+
50
|
|
1528
|
+
]);
|
|
1115
1529
|
const subscriptionPlanSchema = z.enum([
|
|
1116
1530
|
"pro",
|
|
1117
1531
|
"business",
|
|
@@ -1123,17 +1537,70 @@ const customerCreditsSchema = z.object({
|
|
|
1123
1537
|
expiresAt: z.number().nullable(),
|
|
1124
1538
|
currency: z.string()
|
|
1125
1539
|
});
|
|
1126
|
-
const customerUsageSchema = z.object({
|
|
1127
|
-
amountInCents: z.number(),
|
|
1128
|
-
currency: z.string(),
|
|
1129
|
-
periodEnd: z.number()
|
|
1130
|
-
});
|
|
1131
1540
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1132
1541
|
z.object({
|
|
1133
1542
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1134
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1135
1543
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1136
1544
|
});
|
|
1545
|
+
const metricsQueueEventSchema = z.object({
|
|
1546
|
+
ts: z.number().int(),
|
|
1547
|
+
method: z.string(),
|
|
1548
|
+
tool: z.string().nullable(),
|
|
1549
|
+
client: z.string(),
|
|
1550
|
+
sessionId: z.string().nullable(),
|
|
1551
|
+
durationMs: z.number().int(),
|
|
1552
|
+
outputTokens: z.number().int().nullable(),
|
|
1553
|
+
errorType: z.enum([
|
|
1554
|
+
"mcp_error",
|
|
1555
|
+
"tool_error",
|
|
1556
|
+
"timeout"
|
|
1557
|
+
]).nullable(),
|
|
1558
|
+
errorCode: z.number().int().nullable()
|
|
1559
|
+
});
|
|
1560
|
+
z.object({
|
|
1561
|
+
v: z.literal(1),
|
|
1562
|
+
envId: z.string(),
|
|
1563
|
+
events: z.array(metricsQueueEventSchema)
|
|
1564
|
+
});
|
|
1565
|
+
z.object({ v: z.number() });
|
|
1566
|
+
const telemetrySignalSchema = z.enum([
|
|
1567
|
+
"logs",
|
|
1568
|
+
"metrics",
|
|
1569
|
+
"traces"
|
|
1570
|
+
]);
|
|
1571
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1572
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1573
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1574
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1575
|
+
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");
|
|
1576
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1577
|
+
id: z.string(),
|
|
1578
|
+
name: otlpHeaderNameSchema,
|
|
1579
|
+
value: otlpHeaderValueSchema,
|
|
1580
|
+
isSecret: z.boolean()
|
|
1581
|
+
});
|
|
1582
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1583
|
+
"credentials",
|
|
1584
|
+
"wrong-path",
|
|
1585
|
+
"wrong-protocol",
|
|
1586
|
+
"invalid-payload",
|
|
1587
|
+
"partial-rejection",
|
|
1588
|
+
"blocked-target",
|
|
1589
|
+
"timeout",
|
|
1590
|
+
"unreachable",
|
|
1591
|
+
"receiver-error",
|
|
1592
|
+
"unexpected-status"
|
|
1593
|
+
]);
|
|
1594
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1595
|
+
z.object({
|
|
1596
|
+
id: z.string(),
|
|
1597
|
+
signal: telemetrySignalSchema,
|
|
1598
|
+
endpoint: otlpEndpointSchema,
|
|
1599
|
+
protocol: otlpProtocolSchema,
|
|
1600
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1601
|
+
status: telemetryDestinationStatusSchema,
|
|
1602
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1603
|
+
});
|
|
1137
1604
|
//#endregion
|
|
1138
1605
|
//#region src/auth-scope.ts
|
|
1139
1606
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1176,7 +1643,10 @@ const RESERVED_KEYS = [
|
|
|
1176
1643
|
"BUILD_ARG_START_COMMAND",
|
|
1177
1644
|
"ALPIC_HOST",
|
|
1178
1645
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1179
|
-
"ALPIC_INTENT_META_KEY"
|
|
1646
|
+
"ALPIC_INTENT_META_KEY",
|
|
1647
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1648
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1649
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1180
1650
|
];
|
|
1181
1651
|
const environmentVariableSchema = z.object({
|
|
1182
1652
|
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"),
|
|
@@ -1229,6 +1699,14 @@ const serverFieldsSchema = z.object({
|
|
|
1229
1699
|
});
|
|
1230
1700
|
//#endregion
|
|
1231
1701
|
//#region src/api.contract.ts
|
|
1702
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1703
|
+
try {
|
|
1704
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1705
|
+
return true;
|
|
1706
|
+
} catch {
|
|
1707
|
+
return false;
|
|
1708
|
+
}
|
|
1709
|
+
};
|
|
1232
1710
|
const deploymentStatusSchema = z.enum([
|
|
1233
1711
|
"ongoing",
|
|
1234
1712
|
"deployed",
|
|
@@ -1257,21 +1735,20 @@ const deploymentSchema = z.object({
|
|
|
1257
1735
|
isCurrent: z.boolean(),
|
|
1258
1736
|
deploymentPageUrl: z.url().nullable()
|
|
1259
1737
|
});
|
|
1260
|
-
const
|
|
1738
|
+
const isValidTimeInput = (value) => {
|
|
1261
1739
|
if (ms(value) !== void 0) return true;
|
|
1262
1740
|
return !Number.isNaN(new Date(value).getTime());
|
|
1263
1741
|
};
|
|
1264
|
-
const
|
|
1742
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1743
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1744
|
+
const createEnvironmentContractV1 = base.route({
|
|
1265
1745
|
path: "/v1/environments",
|
|
1266
1746
|
method: "POST",
|
|
1267
1747
|
summary: "Create an environment",
|
|
1268
1748
|
description: "Create an environment for a project",
|
|
1269
1749
|
tags: ["environments"],
|
|
1270
1750
|
successDescription: "The environment has been created successfully"
|
|
1271
|
-
}).errors({
|
|
1272
|
-
NOT_FOUND: {},
|
|
1273
|
-
BAD_REQUEST: {}
|
|
1274
|
-
}).input(z.object({
|
|
1751
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1275
1752
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1276
1753
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1277
1754
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1284,7 +1761,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1284
1761
|
createdAt: z.coerce.date(),
|
|
1285
1762
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1286
1763
|
}));
|
|
1287
|
-
const getEnvironmentContractV1 =
|
|
1764
|
+
const getEnvironmentContractV1 = base.route({
|
|
1288
1765
|
path: "/v1/environments/{environmentId}",
|
|
1289
1766
|
method: "GET",
|
|
1290
1767
|
summary: "Get an environment",
|
|
@@ -1300,8 +1777,16 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1300
1777
|
createdAt: z.coerce.date(),
|
|
1301
1778
|
projectId: z.string()
|
|
1302
1779
|
}));
|
|
1780
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1781
|
+
path: "/v1/environments/{environmentId}",
|
|
1782
|
+
method: "DELETE",
|
|
1783
|
+
summary: "Delete an environment",
|
|
1784
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1785
|
+
tags: ["environments"],
|
|
1786
|
+
successDescription: "The environment has been deleted successfully"
|
|
1787
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1303
1788
|
const domainSchema = z.object({
|
|
1304
|
-
|
|
1789
|
+
domain: z.string(),
|
|
1305
1790
|
status: z.enum([
|
|
1306
1791
|
"ongoing",
|
|
1307
1792
|
"deployed",
|
|
@@ -1341,7 +1826,7 @@ const projectOutputSchema = z.object({
|
|
|
1341
1826
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1342
1827
|
environments: z.array(environmentSchema)
|
|
1343
1828
|
});
|
|
1344
|
-
const getProjectContractV1 =
|
|
1829
|
+
const getProjectContractV1 = base.route({
|
|
1345
1830
|
path: "/v1/projects/{projectId}",
|
|
1346
1831
|
method: "GET",
|
|
1347
1832
|
summary: "Get a project",
|
|
@@ -1349,18 +1834,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1349
1834
|
tags: ["projects"],
|
|
1350
1835
|
successDescription: "The project details"
|
|
1351
1836
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1352
|
-
const listProjectsContractV1 =
|
|
1837
|
+
const listProjectsContractV1 = base.route({
|
|
1353
1838
|
path: "/v1/projects",
|
|
1354
1839
|
method: "GET",
|
|
1355
1840
|
summary: "List projects",
|
|
1356
1841
|
description: "List all projects for a team",
|
|
1357
1842
|
tags: ["projects"],
|
|
1358
1843
|
successDescription: "The list of projects"
|
|
1359
|
-
}).errors({
|
|
1360
|
-
|
|
1361
|
-
BAD_REQUEST: {}
|
|
1362
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1363
|
-
const createProjectContractV1 = oc.route({
|
|
1844
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1845
|
+
const createProjectContractV1 = base.route({
|
|
1364
1846
|
path: "/v1/projects",
|
|
1365
1847
|
method: "POST",
|
|
1366
1848
|
summary: "Create a project",
|
|
@@ -1369,7 +1851,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1369
1851
|
successDescription: "The project has been created successfully"
|
|
1370
1852
|
}).errors({
|
|
1371
1853
|
NOT_FOUND: {},
|
|
1372
|
-
BAD_REQUEST: {},
|
|
1373
1854
|
FORBIDDEN: {}
|
|
1374
1855
|
}).input(z.object({
|
|
1375
1856
|
teamId: z.string().optional(),
|
|
@@ -1410,7 +1891,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1410
1891
|
isSecret: z.boolean(),
|
|
1411
1892
|
createdAt: z.coerce.date()
|
|
1412
1893
|
});
|
|
1413
|
-
const listEnvironmentVariablesContractV1 =
|
|
1894
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1414
1895
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1415
1896
|
method: "GET",
|
|
1416
1897
|
summary: "List environment variables",
|
|
@@ -1418,48 +1899,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1418
1899
|
tags: ["environments"],
|
|
1419
1900
|
successDescription: "The list of environment variables"
|
|
1420
1901
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1421
|
-
const createEnvironmentVariablesContractV1 =
|
|
1902
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1422
1903
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1423
1904
|
method: "POST",
|
|
1424
1905
|
summary: "Add environment variables",
|
|
1425
1906
|
description: "Add one or more environment variables to an environment",
|
|
1426
1907
|
tags: ["environments"],
|
|
1427
1908
|
successDescription: "The environment variables have been added successfully"
|
|
1428
|
-
}).errors({
|
|
1429
|
-
NOT_FOUND: {},
|
|
1430
|
-
BAD_REQUEST: {}
|
|
1431
|
-
}).input(z.object({
|
|
1909
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1432
1910
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1433
1911
|
environmentVariables: environmentVariablesSchema
|
|
1434
1912
|
})).output(z.object({ success: z.literal(true) }));
|
|
1435
|
-
const updateEnvironmentVariableContractV1 =
|
|
1913
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1436
1914
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1437
1915
|
method: "PATCH",
|
|
1438
1916
|
summary: "Update an environment variable",
|
|
1439
1917
|
description: "Update an environment variable by ID",
|
|
1440
1918
|
tags: ["environments"],
|
|
1441
1919
|
successDescription: "The environment variable has been updated successfully"
|
|
1442
|
-
}).errors({
|
|
1443
|
-
NOT_FOUND: {},
|
|
1444
|
-
BAD_REQUEST: {}
|
|
1445
|
-
}).input(z.object({
|
|
1920
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1446
1921
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1447
1922
|
key: environmentVariableSchema.shape.key,
|
|
1448
1923
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1449
1924
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1450
1925
|
})).output(z.object({ success: z.literal(true) }));
|
|
1451
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1926
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1452
1927
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1453
1928
|
method: "DELETE",
|
|
1454
1929
|
summary: "Delete an environment variable",
|
|
1455
1930
|
description: "Delete an environment variable by ID",
|
|
1456
1931
|
tags: ["environments"],
|
|
1457
1932
|
successDescription: "The environment variable has been deleted successfully"
|
|
1458
|
-
}).errors({
|
|
1459
|
-
|
|
1460
|
-
BAD_REQUEST: {}
|
|
1461
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1462
|
-
const deleteProjectContractV1 = oc.route({
|
|
1933
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1934
|
+
const deleteProjectContractV1 = base.route({
|
|
1463
1935
|
path: "/v1/projects/{projectId}",
|
|
1464
1936
|
method: "DELETE",
|
|
1465
1937
|
summary: "Delete a project",
|
|
@@ -1467,7 +1939,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1467
1939
|
tags: ["projects"],
|
|
1468
1940
|
successDescription: "The project has been deleted successfully"
|
|
1469
1941
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1470
|
-
const updateProjectContractV1 =
|
|
1942
|
+
const updateProjectContractV1 = base.route({
|
|
1471
1943
|
path: "/v1/projects/{projectId}",
|
|
1472
1944
|
method: "PATCH",
|
|
1473
1945
|
summary: "Update a project",
|
|
@@ -1476,14 +1948,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1476
1948
|
successDescription: "The project has been updated successfully"
|
|
1477
1949
|
}).errors({
|
|
1478
1950
|
NOT_FOUND: {},
|
|
1479
|
-
BAD_REQUEST: {},
|
|
1480
1951
|
FORBIDDEN: {}
|
|
1481
1952
|
}).input(z.object({
|
|
1482
1953
|
projectId: z.string().describe("The ID of the project"),
|
|
1483
1954
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1484
1955
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1485
1956
|
})).output(projectOutputSchema);
|
|
1486
|
-
const deployEnvironmentContractV1 =
|
|
1957
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1487
1958
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1488
1959
|
method: "POST",
|
|
1489
1960
|
summary: "Deploy an environment",
|
|
@@ -1492,27 +1963,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1492
1963
|
successDescription: "The environment has been deployed successfully"
|
|
1493
1964
|
}).errors({
|
|
1494
1965
|
NOT_FOUND: {},
|
|
1495
|
-
|
|
1966
|
+
CONFLICT: {}
|
|
1496
1967
|
}).input(z.object({
|
|
1497
1968
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1498
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1969
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1970
|
+
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.")
|
|
1499
1971
|
})).output(deploymentSchema);
|
|
1500
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1972
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1501
1973
|
path: "/v1/deployments/upload",
|
|
1502
1974
|
method: "POST",
|
|
1503
1975
|
summary: "Upload deployment artifacts",
|
|
1504
1976
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1505
1977
|
tags: ["deployments"],
|
|
1506
1978
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1507
|
-
}).errors({
|
|
1508
|
-
NOT_FOUND: {},
|
|
1509
|
-
BAD_REQUEST: {}
|
|
1510
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1979
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1511
1980
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1512
1981
|
token: z.string().describe("Token to identify the source archive"),
|
|
1513
1982
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1514
1983
|
}));
|
|
1515
|
-
const listDeploymentsContractV1 =
|
|
1984
|
+
const listDeploymentsContractV1 = base.route({
|
|
1516
1985
|
path: "/v1/projects/{projectId}/deployments",
|
|
1517
1986
|
method: "GET",
|
|
1518
1987
|
summary: "List project deployments",
|
|
@@ -1524,7 +1993,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1524
1993
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1525
1994
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1526
1995
|
})).output(z.array(deploymentSchema));
|
|
1527
|
-
const getDeploymentContractV1 =
|
|
1996
|
+
const getDeploymentContractV1 = base.route({
|
|
1528
1997
|
path: "/v1/deployments/{deploymentId}",
|
|
1529
1998
|
method: "GET",
|
|
1530
1999
|
summary: "Get a deployment",
|
|
@@ -1532,20 +2001,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1532
2001
|
tags: ["deployments"],
|
|
1533
2002
|
successDescription: "The deployment details"
|
|
1534
2003
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1535
|
-
const
|
|
2004
|
+
const logEntrySchema = z.object({
|
|
2005
|
+
timestamp: z.coerce.date(),
|
|
2006
|
+
type: z.enum([
|
|
2007
|
+
"START",
|
|
2008
|
+
"END",
|
|
2009
|
+
"INFO",
|
|
2010
|
+
"ERROR",
|
|
2011
|
+
"WARNING",
|
|
2012
|
+
"DEBUG"
|
|
2013
|
+
]),
|
|
2014
|
+
requestId: z.string(),
|
|
2015
|
+
content: z.string().optional(),
|
|
2016
|
+
method: z.string().optional(),
|
|
2017
|
+
durationInMs: z.number().optional()
|
|
2018
|
+
});
|
|
2019
|
+
const getLogsContractV1 = base.route({
|
|
1536
2020
|
path: "/v1/environments/{environmentId}/logs",
|
|
1537
2021
|
method: "GET",
|
|
1538
2022
|
summary: "Get logs",
|
|
1539
2023
|
description: "Get logs for an environment",
|
|
1540
2024
|
tags: ["environments"],
|
|
1541
2025
|
successDescription: "The logs"
|
|
1542
|
-
}).errors({
|
|
1543
|
-
NOT_FOUND: {},
|
|
1544
|
-
BAD_REQUEST: {}
|
|
1545
|
-
}).input(z.object({
|
|
2026
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1546
2027
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1547
|
-
since:
|
|
1548
|
-
until:
|
|
2028
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2029
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1549
2030
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1550
2031
|
level: z.array(z.enum([
|
|
1551
2032
|
"INFO",
|
|
@@ -1556,34 +2037,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1556
2037
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1557
2038
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1558
2039
|
})).output(z.object({
|
|
1559
|
-
logs: z.array(
|
|
1560
|
-
timestamp: z.coerce.date(),
|
|
1561
|
-
type: z.enum([
|
|
1562
|
-
"START",
|
|
1563
|
-
"END",
|
|
1564
|
-
"INFO",
|
|
1565
|
-
"ERROR",
|
|
1566
|
-
"WARNING",
|
|
1567
|
-
"DEBUG"
|
|
1568
|
-
]),
|
|
1569
|
-
requestId: z.string(),
|
|
1570
|
-
content: z.string().optional(),
|
|
1571
|
-
method: z.string().optional(),
|
|
1572
|
-
durationInMs: z.number().optional()
|
|
1573
|
-
})),
|
|
2040
|
+
logs: z.array(logEntrySchema),
|
|
1574
2041
|
nextToken: z.string().nullable()
|
|
1575
2042
|
}));
|
|
1576
|
-
const getLatestLogsContractV1 =
|
|
2043
|
+
const getLatestLogsContractV1 = base.route({
|
|
1577
2044
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1578
2045
|
method: "GET",
|
|
1579
2046
|
summary: "Get latest logs",
|
|
1580
2047
|
description: "Get the N most recent logs for an environment",
|
|
1581
2048
|
tags: ["environments"],
|
|
1582
2049
|
successDescription: "The latest logs"
|
|
1583
|
-
}).errors({
|
|
1584
|
-
NOT_FOUND: {},
|
|
1585
|
-
BAD_REQUEST: {}
|
|
1586
|
-
}).input(z.object({
|
|
2050
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1587
2051
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1588
2052
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1589
2053
|
level: z.array(z.enum([
|
|
@@ -1593,22 +2057,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1593
2057
|
"DEBUG"
|
|
1594
2058
|
])).optional().describe("Filter by log level"),
|
|
1595
2059
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1596
|
-
})).output(z.object({ logs: z.array(
|
|
1597
|
-
|
|
1598
|
-
type: z.enum([
|
|
1599
|
-
"START",
|
|
1600
|
-
"END",
|
|
1601
|
-
"INFO",
|
|
1602
|
-
"ERROR",
|
|
1603
|
-
"WARNING",
|
|
1604
|
-
"DEBUG"
|
|
1605
|
-
]),
|
|
1606
|
-
requestId: z.string(),
|
|
1607
|
-
content: z.string().optional(),
|
|
1608
|
-
method: z.string().optional(),
|
|
1609
|
-
durationInMs: z.number().optional()
|
|
1610
|
-
})) }));
|
|
1611
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
2060
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
2061
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1612
2062
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1613
2063
|
method: "GET",
|
|
1614
2064
|
summary: "Get deployment logs",
|
|
@@ -1635,22 +2085,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1635
2085
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1636
2086
|
task_count: z.array(analyticsDataPointSchema)
|
|
1637
2087
|
});
|
|
1638
|
-
const getProjectAnalyticsContractV1 =
|
|
2088
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1639
2089
|
path: "/v1/analytics/{projectId}",
|
|
1640
2090
|
method: "GET",
|
|
1641
2091
|
summary: "Get project analytics",
|
|
1642
2092
|
description: "Get analytics data for a project over a time range",
|
|
1643
2093
|
tags: ["analytics"],
|
|
1644
2094
|
successDescription: "The project analytics data"
|
|
1645
|
-
}).errors({
|
|
1646
|
-
NOT_FOUND: {},
|
|
1647
|
-
BAD_REQUEST: {}
|
|
1648
|
-
}).input(z.object({
|
|
2095
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1649
2096
|
projectId: z.string().describe("The ID of the project"),
|
|
1650
2097
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1651
2098
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1652
2099
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1653
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2100
|
+
}).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({
|
|
1654
2101
|
metadata: z.object({
|
|
1655
2102
|
startTimestamp: z.number(),
|
|
1656
2103
|
endTimestamp: z.number(),
|
|
@@ -1660,7 +2107,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1660
2107
|
}),
|
|
1661
2108
|
timeSeries: analyticsTimeSeriesSchema
|
|
1662
2109
|
}));
|
|
1663
|
-
const
|
|
2110
|
+
const paginatedInsightsInputShape = {
|
|
2111
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2112
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2113
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2114
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2115
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2116
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2117
|
+
};
|
|
2118
|
+
const listIntentsContractV1 = base.route({
|
|
2119
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2120
|
+
method: "GET",
|
|
2121
|
+
summary: "List intents",
|
|
2122
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2123
|
+
tags: ["insights"],
|
|
2124
|
+
successDescription: "The grouped user intents"
|
|
2125
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2126
|
+
...paginatedInsightsInputShape,
|
|
2127
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2128
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2129
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2130
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2131
|
+
})).output(z.object({
|
|
2132
|
+
intents: z.array(z.object({
|
|
2133
|
+
id: z.string(),
|
|
2134
|
+
intentIds: z.array(z.string()).min(1),
|
|
2135
|
+
environmentId: z.string(),
|
|
2136
|
+
message: z.string(),
|
|
2137
|
+
toolName: z.string(),
|
|
2138
|
+
createdAt: z.coerce.date(),
|
|
2139
|
+
occurrenceCount: z.number().int().positive(),
|
|
2140
|
+
clientName: z.string().nullable(),
|
|
2141
|
+
clientId: z.string().nullable(),
|
|
2142
|
+
categories: z.array(z.object({
|
|
2143
|
+
id: z.string(),
|
|
2144
|
+
name: z.string(),
|
|
2145
|
+
color: intentCategoryColorSchema
|
|
2146
|
+
}))
|
|
2147
|
+
})),
|
|
2148
|
+
totalCount: z.number().int().nonnegative()
|
|
2149
|
+
}));
|
|
2150
|
+
const listFeedbacksContractV1 = base.route({
|
|
2151
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2152
|
+
method: "GET",
|
|
2153
|
+
summary: "List feedbacks",
|
|
2154
|
+
description: "List user feedback for an environment over a time range",
|
|
2155
|
+
tags: ["insights"],
|
|
2156
|
+
successDescription: "The user feedback"
|
|
2157
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2158
|
+
...paginatedInsightsInputShape,
|
|
2159
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2160
|
+
})).output(z.object({
|
|
2161
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2162
|
+
totalCount: z.number().int().nonnegative()
|
|
2163
|
+
}));
|
|
2164
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2165
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2166
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2167
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2168
|
+
method: "GET",
|
|
2169
|
+
summary: "List intent categories",
|
|
2170
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2171
|
+
tags: ["insights"],
|
|
2172
|
+
successDescription: "The intent categories"
|
|
2173
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2174
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2175
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2176
|
+
method: "POST",
|
|
2177
|
+
summary: "Create an intent category",
|
|
2178
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2179
|
+
tags: ["insights"],
|
|
2180
|
+
successDescription: "The created intent category"
|
|
2181
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2182
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2183
|
+
name: intentCategoryNameSchema,
|
|
2184
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2185
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2186
|
+
})).output(intentCategorySchema);
|
|
2187
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2188
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2189
|
+
method: "PATCH",
|
|
2190
|
+
summary: "Update an intent category",
|
|
2191
|
+
description: "Rename or recolor an intent category",
|
|
2192
|
+
tags: ["insights"],
|
|
2193
|
+
successDescription: "The updated intent category"
|
|
2194
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2195
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2196
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2197
|
+
name: intentCategoryNameSchema.optional(),
|
|
2198
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2199
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2200
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2201
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2202
|
+
method: "DELETE",
|
|
2203
|
+
summary: "Delete an intent category",
|
|
2204
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2205
|
+
tags: ["insights"],
|
|
2206
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2207
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2208
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2209
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2210
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2211
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2212
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2213
|
+
method: "POST",
|
|
2214
|
+
summary: "Link an intent category",
|
|
2215
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2216
|
+
tags: ["insights"],
|
|
2217
|
+
successDescription: "The intents have been linked successfully"
|
|
2218
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2219
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2220
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2221
|
+
intentIds: categorizableIntentIdsSchema
|
|
2222
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2223
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2224
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2225
|
+
method: "POST",
|
|
2226
|
+
summary: "Unlink an intent category",
|
|
2227
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2228
|
+
tags: ["insights"],
|
|
2229
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2230
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2231
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2232
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2233
|
+
intentIds: categorizableIntentIdsSchema
|
|
2234
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2235
|
+
const listTeamsContractV1 = base.route({
|
|
1664
2236
|
path: "/v1/teams",
|
|
1665
2237
|
method: "GET",
|
|
1666
2238
|
summary: "List teams",
|
|
@@ -1673,7 +2245,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1673
2245
|
createdAt: z.coerce.date(),
|
|
1674
2246
|
hasStripeAccount: z.boolean()
|
|
1675
2247
|
})));
|
|
1676
|
-
const
|
|
2248
|
+
const getTeamUsageContractV1 = base.route({
|
|
2249
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2250
|
+
method: "GET",
|
|
2251
|
+
summary: "Get team usage",
|
|
2252
|
+
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.",
|
|
2253
|
+
tags: ["teams"],
|
|
2254
|
+
successDescription: "The current billing window usage"
|
|
2255
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2256
|
+
teamId: z.string(),
|
|
2257
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2258
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2259
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2260
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2261
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2262
|
+
}));
|
|
2263
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1677
2264
|
path: "/v1/tunnels/ticket",
|
|
1678
2265
|
method: "GET",
|
|
1679
2266
|
summary: "Get a tunnel ticket",
|
|
@@ -1685,16 +2272,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1685
2272
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1686
2273
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1687
2274
|
}));
|
|
1688
|
-
const publishServerContractV1 =
|
|
2275
|
+
const publishServerContractV1 = base.route({
|
|
1689
2276
|
path: "/v1/distribution/publish",
|
|
1690
2277
|
method: "POST",
|
|
1691
2278
|
summary: "Publish a server to the MCP registry",
|
|
1692
2279
|
tags: ["distribution"],
|
|
1693
2280
|
successDescription: "The server has been published successfully"
|
|
1694
|
-
}).errors({
|
|
1695
|
-
NOT_FOUND: {},
|
|
1696
|
-
BAD_REQUEST: {}
|
|
1697
|
-
}).input(z.object({
|
|
2281
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1698
2282
|
projectId: z.string(),
|
|
1699
2283
|
domain: z.string(),
|
|
1700
2284
|
title: z.string().min(1).max(100),
|
|
@@ -1703,17 +2287,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1703
2287
|
iconSrc: z.url().max(255).optional(),
|
|
1704
2288
|
dryRun: z.boolean().optional()
|
|
1705
2289
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1706
|
-
const getServerInfoContractV1 =
|
|
2290
|
+
const getServerInfoContractV1 = base.route({
|
|
1707
2291
|
path: "/v1/distribution/get",
|
|
1708
2292
|
method: "GET",
|
|
1709
2293
|
summary: "Get server info",
|
|
1710
2294
|
description: "Get info about a server",
|
|
1711
2295
|
tags: ["distribution"],
|
|
1712
2296
|
successDescription: "The server info"
|
|
1713
|
-
}).errors({
|
|
1714
|
-
NOT_FOUND: {},
|
|
1715
|
-
BAD_REQUEST: {}
|
|
1716
|
-
}).input(z.object({
|
|
2297
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1717
2298
|
projectId: z.string(),
|
|
1718
2299
|
domain: z.string()
|
|
1719
2300
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1732,7 +2313,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1732
2313
|
isPlaygroundEnabled: z.boolean(),
|
|
1733
2314
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1734
2315
|
});
|
|
1735
|
-
const getPlaygroundContractV1 =
|
|
2316
|
+
const getPlaygroundContractV1 = base.route({
|
|
1736
2317
|
path: "/v1/environments/{environmentId}/playground",
|
|
1737
2318
|
method: "GET",
|
|
1738
2319
|
summary: "Get playground configuration",
|
|
@@ -1740,17 +2321,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1740
2321
|
tags: ["environments"],
|
|
1741
2322
|
successDescription: "The playground configuration"
|
|
1742
2323
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1743
|
-
const upsertPlaygroundContractV1 =
|
|
2324
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1744
2325
|
path: "/v1/environments/{environmentId}/playground",
|
|
1745
2326
|
method: "PUT",
|
|
1746
2327
|
summary: "Update playground configuration",
|
|
1747
2328
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1748
2329
|
tags: ["environments"],
|
|
1749
2330
|
successDescription: "The updated playground configuration"
|
|
1750
|
-
}).errors({
|
|
1751
|
-
NOT_FOUND: {},
|
|
1752
|
-
BAD_REQUEST: {}
|
|
1753
|
-
}).input(z.object({
|
|
2331
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1754
2332
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1755
2333
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1756
2334
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1758,7 +2336,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1758
2336
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1759
2337
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1760
2338
|
})).output(playgroundOutputSchema);
|
|
1761
|
-
const createBeaconContractV1 =
|
|
2339
|
+
const createBeaconContractV1 = base.route({
|
|
1762
2340
|
path: "/v1/beacon/audits",
|
|
1763
2341
|
method: "POST",
|
|
1764
2342
|
summary: "Create a beacon audit",
|
|
@@ -1767,7 +2345,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1767
2345
|
successDescription: "The audit has been created"
|
|
1768
2346
|
}).errors({
|
|
1769
2347
|
NOT_FOUND: {},
|
|
1770
|
-
BAD_REQUEST: {},
|
|
1771
2348
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1772
2349
|
}).input(z.object({
|
|
1773
2350
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1775,7 +2352,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1775
2352
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1776
2353
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1777
2354
|
})).output(z.object({ id: z.string() }));
|
|
1778
|
-
const getBeaconContractV1 =
|
|
2355
|
+
const getBeaconContractV1 = base.route({
|
|
1779
2356
|
path: "/v1/beacon/audits/{auditId}",
|
|
1780
2357
|
method: "GET",
|
|
1781
2358
|
summary: "Get a beacon audit",
|
|
@@ -1790,9 +2367,73 @@ const getBeaconContractV1 = oc.route({
|
|
|
1790
2367
|
createdAt: z.coerce.date(),
|
|
1791
2368
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1792
2369
|
}));
|
|
2370
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2371
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2372
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2373
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2374
|
+
const createSubmissionContractV1 = base.route({
|
|
2375
|
+
path: "/v1/submissions",
|
|
2376
|
+
method: "POST",
|
|
2377
|
+
summary: "Create a submission package",
|
|
2378
|
+
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.",
|
|
2379
|
+
tags: ["submissions"],
|
|
2380
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2381
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2382
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2383
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2384
|
+
})).output(submissionSchema);
|
|
2385
|
+
const listSubmissionsContractV1 = base.route({
|
|
2386
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2387
|
+
method: "GET",
|
|
2388
|
+
summary: "List submission packages",
|
|
2389
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2390
|
+
tags: ["submissions"],
|
|
2391
|
+
successDescription: "The list of submission packages"
|
|
2392
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2393
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2394
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2395
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2396
|
+
})).output(z.array(submissionSchema));
|
|
2397
|
+
const getSubmissionContractV1 = base.route({
|
|
2398
|
+
path: "/v1/submissions/{submissionId}",
|
|
2399
|
+
method: "GET",
|
|
2400
|
+
summary: "Get a submission package",
|
|
2401
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2402
|
+
tags: ["submissions"],
|
|
2403
|
+
successDescription: "The submission package"
|
|
2404
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2405
|
+
const updateSubmissionContractV1 = base.route({
|
|
2406
|
+
path: "/v1/submissions/{submissionId}",
|
|
2407
|
+
method: "PUT",
|
|
2408
|
+
summary: "Update a submission package",
|
|
2409
|
+
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.",
|
|
2410
|
+
tags: ["submissions"],
|
|
2411
|
+
successDescription: "The updated submission package"
|
|
2412
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2413
|
+
submissionId: submissionIdSchema,
|
|
2414
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2415
|
+
formData: claudeSubmissionUpdateSchema
|
|
2416
|
+
}), z.object({
|
|
2417
|
+
submissionId: submissionIdSchema,
|
|
2418
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2419
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2420
|
+
})])).output(submissionSchema);
|
|
1793
2421
|
const contract = {
|
|
1794
|
-
teams: {
|
|
2422
|
+
teams: {
|
|
2423
|
+
list: { v1: listTeamsContractV1 },
|
|
2424
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2425
|
+
},
|
|
1795
2426
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2427
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2428
|
+
intentCategories: {
|
|
2429
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2430
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2431
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2432
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2433
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2434
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2435
|
+
},
|
|
2436
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1796
2437
|
deployments: {
|
|
1797
2438
|
list: { v1: listDeploymentsContractV1 },
|
|
1798
2439
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1802,6 +2443,7 @@ const contract = {
|
|
|
1802
2443
|
environments: {
|
|
1803
2444
|
create: { v1: createEnvironmentContractV1 },
|
|
1804
2445
|
get: { v1: getEnvironmentContractV1 },
|
|
2446
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1805
2447
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1806
2448
|
getLogs: { v1: getLogsContractV1 },
|
|
1807
2449
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1831,7 +2473,39 @@ const contract = {
|
|
|
1831
2473
|
beacon: {
|
|
1832
2474
|
create: { v1: createBeaconContractV1 },
|
|
1833
2475
|
get: { v1: getBeaconContractV1 }
|
|
2476
|
+
},
|
|
2477
|
+
submissions: {
|
|
2478
|
+
create: { v1: createSubmissionContractV1 },
|
|
2479
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2480
|
+
get: { v1: getSubmissionContractV1 },
|
|
2481
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2482
|
+
}
|
|
2483
|
+
};
|
|
2484
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2485
|
+
const contractForDocs = {
|
|
2486
|
+
...contract,
|
|
2487
|
+
deployments: deploymentsForDocs
|
|
2488
|
+
};
|
|
2489
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2490
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2491
|
+
info: {
|
|
2492
|
+
title: "Alpic API",
|
|
2493
|
+
version: "1.0.0"
|
|
2494
|
+
},
|
|
2495
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2496
|
+
security: [{ bearerAuth: [] }],
|
|
2497
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2498
|
+
type: "http",
|
|
2499
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2500
|
+
scheme: "bearer"
|
|
2501
|
+
} } },
|
|
2502
|
+
commonSchemas: {
|
|
2503
|
+
Submission: { schema: submissionSchema },
|
|
2504
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2505
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2506
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2507
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
1834
2508
|
}
|
|
1835
2509
|
};
|
|
1836
2510
|
//#endregion
|
|
1837
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2511
|
+
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 };
|