@alpic-ai/api 0.0.0-dev.gd5c7a44 → 0.0.0-dev.gd618ca0
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 +6698 -95
- package/dist/index.mjs +975 -223
- package/package.json +10 -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.32.0_supports-color@8.1.1_zod@4.5.4/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -119,7 +119,12 @@ z$1.object({
|
|
|
119
119
|
token_type: z$1.string(),
|
|
120
120
|
expires_in: z$1.coerce.number().optional(),
|
|
121
121
|
scope: z$1.string().optional(),
|
|
122
|
-
refresh_token: z$1.string().optional()
|
|
122
|
+
refresh_token: z$1.string().optional(),
|
|
123
|
+
/**
|
|
124
|
+
* Not part of the wire format: the authorization server this value was obtained from, added by
|
|
125
|
+
* the client's `auth()` before it is stored and compared when it is read back.
|
|
126
|
+
*/
|
|
127
|
+
issuer: z$1.string().optional().catch(void 0)
|
|
123
128
|
}).strip();
|
|
124
129
|
z$1.object({
|
|
125
130
|
error: z$1.string(),
|
|
@@ -158,7 +163,12 @@ const OAuthClientInformationSchema = z$1.object({
|
|
|
158
163
|
client_id: z$1.string(),
|
|
159
164
|
client_secret: z$1.string().optional(),
|
|
160
165
|
client_id_issued_at: z$1.number().optional(),
|
|
161
|
-
client_secret_expires_at: z$1.number().optional()
|
|
166
|
+
client_secret_expires_at: z$1.number().optional(),
|
|
167
|
+
/**
|
|
168
|
+
* Not part of the wire format: the authorization server this value was obtained from, added by
|
|
169
|
+
* the client's `auth()` before it is stored and compared when it is read back.
|
|
170
|
+
*/
|
|
171
|
+
issuer: z$1.string().optional().catch(void 0)
|
|
162
172
|
}).strip();
|
|
163
173
|
OAuthClientMetadataSchema.merge(OAuthClientInformationSchema);
|
|
164
174
|
z$1.object({
|
|
@@ -169,11 +179,22 @@ z$1.object({
|
|
|
169
179
|
token: z$1.string(),
|
|
170
180
|
token_type_hint: z$1.string().optional()
|
|
171
181
|
}).strip();
|
|
172
|
-
|
|
182
|
+
//#endregion
|
|
183
|
+
//#region ../domains/dist/index.mjs
|
|
184
|
+
const AI_PLATFORMS = ["chatgpt", "claudeai"];
|
|
185
|
+
const platformSchema = z.enum(AI_PLATFORMS);
|
|
173
186
|
const PLATFORM_LABELS = {
|
|
174
187
|
chatgpt: "ChatGPT",
|
|
175
188
|
claudeai: "Claude.ai"
|
|
176
189
|
};
|
|
190
|
+
const WAF_PLATFORMS = [
|
|
191
|
+
"akamai",
|
|
192
|
+
"cato",
|
|
193
|
+
"cloudflare",
|
|
194
|
+
"fastly"
|
|
195
|
+
];
|
|
196
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
197
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
177
198
|
const auditStatusSchema = z.enum([
|
|
178
199
|
"pending",
|
|
179
200
|
"partial",
|
|
@@ -246,6 +267,25 @@ z.object({
|
|
|
246
267
|
clientSecret: z.string(),
|
|
247
268
|
clientScopes: z.array(z.string())
|
|
248
269
|
});
|
|
270
|
+
const creditEntryReasonSchema = z.enum([
|
|
271
|
+
"free_seed",
|
|
272
|
+
"paid_conversion_floor",
|
|
273
|
+
"top_up",
|
|
274
|
+
"usage",
|
|
275
|
+
"admin_adjustment"
|
|
276
|
+
]);
|
|
277
|
+
z.enum(["playground"]);
|
|
278
|
+
z.number().int().min(500);
|
|
279
|
+
const creditActivityEntrySchema = z.object({
|
|
280
|
+
reason: creditEntryReasonSchema,
|
|
281
|
+
day: z.number(),
|
|
282
|
+
amountInNanoUSD: z.number(),
|
|
283
|
+
messageCount: z.number().nullable()
|
|
284
|
+
});
|
|
285
|
+
z.object({
|
|
286
|
+
balanceInNanoUSD: z.number(),
|
|
287
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
288
|
+
});
|
|
249
289
|
const deploymentStatusSchema$1 = z.enum([
|
|
250
290
|
"ongoing",
|
|
251
291
|
"deployed",
|
|
@@ -273,34 +313,52 @@ const deploymentSummarySchema = z.object({
|
|
|
273
313
|
createdAt: z.coerce.date(),
|
|
274
314
|
updatedAt: z.coerce.date()
|
|
275
315
|
});
|
|
276
|
-
/**
|
|
277
|
-
* Public environment
|
|
278
|
-
*
|
|
279
|
-
* No OAuth metadata exposed.
|
|
280
|
-
*/
|
|
316
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
281
317
|
const publicEnvironmentSchema = z.object({
|
|
318
|
+
allowsAnonymous: z.literal(true),
|
|
319
|
+
oAuthMetadata: z.strictObject({})
|
|
320
|
+
});
|
|
321
|
+
/** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
|
|
322
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
323
|
+
allowsAnonymous: z.boolean(),
|
|
324
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
325
|
+
scope: z.string().optional()
|
|
326
|
+
});
|
|
327
|
+
/** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
|
|
328
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
329
|
+
allowsAnonymous: z.boolean(),
|
|
330
|
+
oAuthMetadata: z.object({
|
|
331
|
+
externalAuthorizationServerUrl: z.url(),
|
|
332
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
333
|
+
}),
|
|
334
|
+
scope: z.string().optional()
|
|
335
|
+
});
|
|
336
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
337
|
+
const standaloneEnvironmentSchema = z.object({
|
|
338
|
+
allowsAnonymous: z.boolean(),
|
|
339
|
+
oAuthMetadata: z.object({
|
|
340
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
341
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
342
|
+
}),
|
|
343
|
+
scope: z.string().optional()
|
|
344
|
+
});
|
|
345
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
346
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
347
|
+
allowsAnonymous: z.literal(false),
|
|
348
|
+
oAuthMetadata: z.strictObject({}),
|
|
349
|
+
scope: z.string().optional(),
|
|
350
|
+
wwwAuthenticate: z.string().optional()
|
|
351
|
+
});
|
|
352
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
282
353
|
isPublic: z.literal(true),
|
|
283
354
|
oAuthMetadata: z.undefined().optional()
|
|
284
355
|
});
|
|
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({
|
|
356
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
292
357
|
isPublic: z.literal(false),
|
|
293
358
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
359
|
scope: z.string().optional()
|
|
295
360
|
});
|
|
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({
|
|
361
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
362
|
isPublic: z.literal(false),
|
|
305
363
|
oAuthMetadata: z.object({
|
|
306
364
|
externalAuthorizationServerUrl: z.url(),
|
|
@@ -308,13 +366,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
308
366
|
}),
|
|
309
367
|
scope: z.string().optional()
|
|
310
368
|
});
|
|
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({
|
|
369
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
318
370
|
isPublic: z.literal(false),
|
|
319
371
|
oAuthMetadata: z.object({
|
|
320
372
|
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
@@ -322,14 +374,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
322
374
|
}),
|
|
323
375
|
scope: z.string().optional()
|
|
324
376
|
});
|
|
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({
|
|
377
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
378
|
isPublic: z.literal(false),
|
|
334
379
|
oAuthMetadata: z.strictObject({}),
|
|
335
380
|
scope: z.string().optional()
|
|
@@ -339,9 +384,13 @@ z.union([
|
|
|
339
384
|
externalResourceMetadataEnvironmentSchema,
|
|
340
385
|
externalAuthorizationServerEnvironmentSchema,
|
|
341
386
|
standaloneEnvironmentSchema,
|
|
342
|
-
protectedWithoutDiscoveryEnvironmentSchema
|
|
387
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
388
|
+
legacyPublicEnvironmentSchema,
|
|
389
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
390
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
391
|
+
legacyStandaloneEnvironmentSchema,
|
|
392
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
343
393
|
]);
|
|
344
|
-
const allowedPlatformSchema = platformSchema;
|
|
345
394
|
const playgroundModelSchema = z.enum([
|
|
346
395
|
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
347
396
|
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
@@ -381,14 +430,17 @@ z.object({
|
|
|
381
430
|
collectRequestPayload: z.boolean(),
|
|
382
431
|
collectResponsePayload: z.boolean(),
|
|
383
432
|
collectErrorMessage: z.boolean(),
|
|
384
|
-
collectUserData: z.boolean()
|
|
433
|
+
collectUserData: z.boolean(),
|
|
434
|
+
identityTraitKey: z.string().min(1).max(200).nullable(),
|
|
435
|
+
leadEventName: z.string().min(1).max(200).nullable()
|
|
385
436
|
});
|
|
386
|
-
z.object({
|
|
437
|
+
const feedbackSchema = z.object({
|
|
387
438
|
id: z.string(),
|
|
388
439
|
createdAt: z.coerce.date(),
|
|
389
440
|
environmentId: z.string(),
|
|
390
441
|
content: z.string(),
|
|
391
|
-
source: z.enum(["model", "user"])
|
|
442
|
+
source: z.enum(["model", "user"]),
|
|
443
|
+
clientName: z.string().nullable()
|
|
392
444
|
});
|
|
393
445
|
z.object({
|
|
394
446
|
content: z.string(),
|
|
@@ -404,7 +456,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
404
456
|
"pink",
|
|
405
457
|
"gray"
|
|
406
458
|
]);
|
|
407
|
-
intentCategoryColorSchema.options;
|
|
459
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
408
460
|
const intentCategorySchema = z.object({
|
|
409
461
|
id: z.string(),
|
|
410
462
|
createdAt: z.coerce.date(),
|
|
@@ -412,7 +464,7 @@ const intentCategorySchema = z.object({
|
|
|
412
464
|
name: z.string(),
|
|
413
465
|
color: intentCategoryColorSchema
|
|
414
466
|
});
|
|
415
|
-
z.object({
|
|
467
|
+
const intentCategorySummarySchema = z.object({
|
|
416
468
|
id: z.string(),
|
|
417
469
|
name: z.string(),
|
|
418
470
|
color: intentCategoryColorSchema,
|
|
@@ -424,6 +476,7 @@ z.object({
|
|
|
424
476
|
environmentId: z.string(),
|
|
425
477
|
toolName: z.string(),
|
|
426
478
|
message: z.string(),
|
|
479
|
+
clientName: z.string().nullable(),
|
|
427
480
|
categories: z.array(intentCategorySchema)
|
|
428
481
|
});
|
|
429
482
|
const signalCategorySchema = z.object({
|
|
@@ -482,12 +535,270 @@ z.object({
|
|
|
482
535
|
createdAt: z.coerce.date(),
|
|
483
536
|
updatedAt: z.coerce.date()
|
|
484
537
|
});
|
|
538
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
539
|
+
type: z.literal("mcp_request"),
|
|
540
|
+
method: z.string()
|
|
541
|
+
});
|
|
542
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
543
|
+
type: z.literal("mcp_error"),
|
|
544
|
+
method: z.string(),
|
|
545
|
+
error: z.string()
|
|
546
|
+
});
|
|
547
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
485
548
|
z.enum([
|
|
486
549
|
"INFO",
|
|
487
550
|
"WARNING",
|
|
488
551
|
"DEBUG",
|
|
489
552
|
"ERROR"
|
|
490
553
|
]);
|
|
554
|
+
const LOG_SEARCH_MAX_ESCAPED_LENGTH = 960;
|
|
555
|
+
function escapeLogSearchTerm(search) {
|
|
556
|
+
return [...search].flatMap((character) => [...new TextEncoder().encode(character)]).map((byte) => {
|
|
557
|
+
const character = String.fromCharCode(byte);
|
|
558
|
+
return /^[a-zA-Z0-9]$/.test(character) ? character : `\\x${byte.toString(16).toUpperCase().padStart(2, "0")}`;
|
|
559
|
+
}).join("");
|
|
560
|
+
}
|
|
561
|
+
const logSearchSchema = z.string().max(240, `Search must be 240 characters or fewer`).refine((search) => escapeLogSearchTerm(search).length <= LOG_SEARCH_MAX_ESCAPED_LENGTH, "Search is too complex; shorten it or use fewer special characters");
|
|
562
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
563
|
+
const MCP_CLIENT_GROUPS = [
|
|
564
|
+
{
|
|
565
|
+
id: "claude_code",
|
|
566
|
+
label: "Claude Code",
|
|
567
|
+
vendor: "anthropic",
|
|
568
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
569
|
+
},
|
|
570
|
+
{
|
|
571
|
+
id: "claude",
|
|
572
|
+
label: "Claude",
|
|
573
|
+
vendor: "anthropic",
|
|
574
|
+
rawNames: [
|
|
575
|
+
"Anthropic/ClaudeAI",
|
|
576
|
+
"claude-ai",
|
|
577
|
+
"claude",
|
|
578
|
+
"Claude",
|
|
579
|
+
"claude-desktop",
|
|
580
|
+
"claude-desktop-3p"
|
|
581
|
+
]
|
|
582
|
+
},
|
|
583
|
+
{
|
|
584
|
+
id: "claude_mobile",
|
|
585
|
+
label: "Claude mobile",
|
|
586
|
+
vendor: "anthropic",
|
|
587
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
588
|
+
},
|
|
589
|
+
{
|
|
590
|
+
id: "claude_cowork",
|
|
591
|
+
label: "Claude Cowork",
|
|
592
|
+
vendor: "anthropic",
|
|
593
|
+
rawNames: ["Anthropic/Cowork"]
|
|
594
|
+
},
|
|
595
|
+
{
|
|
596
|
+
id: "claude_toolbox",
|
|
597
|
+
label: "Claude Toolbox",
|
|
598
|
+
vendor: "anthropic",
|
|
599
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
600
|
+
},
|
|
601
|
+
{
|
|
602
|
+
id: "anthropic_api",
|
|
603
|
+
label: "Anthropic API",
|
|
604
|
+
vendor: "anthropic",
|
|
605
|
+
rawNames: ["Anthropic/API"]
|
|
606
|
+
},
|
|
607
|
+
{
|
|
608
|
+
id: "anthropic_connector_refresh",
|
|
609
|
+
label: "Anthropic (connector refresh)",
|
|
610
|
+
vendor: "anthropic",
|
|
611
|
+
rawNames: ["Anthropic"]
|
|
612
|
+
},
|
|
613
|
+
{
|
|
614
|
+
id: "codex",
|
|
615
|
+
label: "Codex",
|
|
616
|
+
vendor: "openai",
|
|
617
|
+
rawNames: [
|
|
618
|
+
"codex-mcp-client",
|
|
619
|
+
"codex",
|
|
620
|
+
"Codex",
|
|
621
|
+
"codex-cli",
|
|
622
|
+
"openai-mcp (Codex)"
|
|
623
|
+
]
|
|
624
|
+
},
|
|
625
|
+
{
|
|
626
|
+
id: "chatgpt",
|
|
627
|
+
label: "ChatGPT",
|
|
628
|
+
vendor: "openai",
|
|
629
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
630
|
+
},
|
|
631
|
+
{
|
|
632
|
+
id: "openai_responses_api",
|
|
633
|
+
label: "OpenAI Responses API",
|
|
634
|
+
vendor: "openai",
|
|
635
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
636
|
+
},
|
|
637
|
+
{
|
|
638
|
+
id: "openai_agent_builder",
|
|
639
|
+
label: "OpenAI Agent Builder",
|
|
640
|
+
vendor: "openai",
|
|
641
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
642
|
+
},
|
|
643
|
+
{
|
|
644
|
+
id: "openai_other",
|
|
645
|
+
label: "OpenAI Other",
|
|
646
|
+
vendor: "openai",
|
|
647
|
+
rawNames: ["openai-mcp"]
|
|
648
|
+
},
|
|
649
|
+
{
|
|
650
|
+
id: "cursor",
|
|
651
|
+
label: "Cursor",
|
|
652
|
+
vendor: "cursor",
|
|
653
|
+
rawNames: [
|
|
654
|
+
"cursor-vscode",
|
|
655
|
+
"Cursor",
|
|
656
|
+
"cursor"
|
|
657
|
+
]
|
|
658
|
+
},
|
|
659
|
+
{
|
|
660
|
+
id: "cline",
|
|
661
|
+
label: "Cline",
|
|
662
|
+
vendor: "cline",
|
|
663
|
+
rawNames: [
|
|
664
|
+
"Cline",
|
|
665
|
+
"cline",
|
|
666
|
+
"@cline/core"
|
|
667
|
+
]
|
|
668
|
+
},
|
|
669
|
+
{
|
|
670
|
+
id: "github_copilot",
|
|
671
|
+
label: "GitHub Copilot",
|
|
672
|
+
vendor: "githubCopilot",
|
|
673
|
+
rawNames: [
|
|
674
|
+
"Copilot",
|
|
675
|
+
"github-copilot-developer",
|
|
676
|
+
"Copilot MCP Gateway",
|
|
677
|
+
"Xcode/copilot-xcode"
|
|
678
|
+
]
|
|
679
|
+
},
|
|
680
|
+
{
|
|
681
|
+
id: "gemini_cli",
|
|
682
|
+
label: "Gemini CLI",
|
|
683
|
+
vendor: "google",
|
|
684
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
685
|
+
},
|
|
686
|
+
{
|
|
687
|
+
id: "antigravity",
|
|
688
|
+
label: "Antigravity",
|
|
689
|
+
vendor: "google",
|
|
690
|
+
rawNames: ["antigravity-client"]
|
|
691
|
+
},
|
|
692
|
+
{
|
|
693
|
+
id: "gemini",
|
|
694
|
+
label: "Gemini",
|
|
695
|
+
vendor: "google",
|
|
696
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
697
|
+
},
|
|
698
|
+
{
|
|
699
|
+
id: "windsurf",
|
|
700
|
+
label: "Windsurf",
|
|
701
|
+
vendor: "windsurf",
|
|
702
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
703
|
+
},
|
|
704
|
+
{
|
|
705
|
+
id: "mistral",
|
|
706
|
+
label: "Mistral / Le Chat",
|
|
707
|
+
vendor: "mistral",
|
|
708
|
+
rawNames: ["Mistral"],
|
|
709
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
710
|
+
},
|
|
711
|
+
{
|
|
712
|
+
id: "n8n",
|
|
713
|
+
label: "n8n",
|
|
714
|
+
vendor: "n8n",
|
|
715
|
+
rawNames: [
|
|
716
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
717
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
718
|
+
"n8n"
|
|
719
|
+
]
|
|
720
|
+
},
|
|
721
|
+
{
|
|
722
|
+
id: "alpic_playground",
|
|
723
|
+
label: "Alpic Playground",
|
|
724
|
+
vendor: "alpic",
|
|
725
|
+
rawNames: ["alpic-playground", "playground"]
|
|
726
|
+
},
|
|
727
|
+
{
|
|
728
|
+
id: "opencode",
|
|
729
|
+
label: "opencode",
|
|
730
|
+
vendor: "opencode",
|
|
731
|
+
rawNames: ["opencode"]
|
|
732
|
+
},
|
|
733
|
+
{
|
|
734
|
+
id: "zed",
|
|
735
|
+
label: "Zed",
|
|
736
|
+
vendor: "zed",
|
|
737
|
+
rawNames: ["Zed", "zed"]
|
|
738
|
+
},
|
|
739
|
+
{
|
|
740
|
+
id: "zapier",
|
|
741
|
+
label: "Zapier",
|
|
742
|
+
vendor: "zapier",
|
|
743
|
+
rawNames: ["Zapier", "zapier"]
|
|
744
|
+
},
|
|
745
|
+
{
|
|
746
|
+
id: "make",
|
|
747
|
+
label: "Make",
|
|
748
|
+
vendor: "make",
|
|
749
|
+
rawNames: ["Make", "make"]
|
|
750
|
+
},
|
|
751
|
+
{
|
|
752
|
+
id: "librechat",
|
|
753
|
+
label: "LibreChat",
|
|
754
|
+
vendor: "mcp",
|
|
755
|
+
rawNames: ["LibreChat", "librechat"]
|
|
756
|
+
},
|
|
757
|
+
{
|
|
758
|
+
id: "jan",
|
|
759
|
+
label: "Jan",
|
|
760
|
+
vendor: "mcp",
|
|
761
|
+
rawNames: ["Jan", "jan"]
|
|
762
|
+
},
|
|
763
|
+
{
|
|
764
|
+
id: "goose",
|
|
765
|
+
label: "goose",
|
|
766
|
+
vendor: "mcp",
|
|
767
|
+
rawNames: ["goose", "Goose"]
|
|
768
|
+
},
|
|
769
|
+
{
|
|
770
|
+
id: "mcphost",
|
|
771
|
+
label: "mcphost",
|
|
772
|
+
vendor: "mcp",
|
|
773
|
+
rawNames: ["mcphost"]
|
|
774
|
+
},
|
|
775
|
+
{
|
|
776
|
+
id: "mcporter",
|
|
777
|
+
label: "mcporter",
|
|
778
|
+
vendor: "mcp",
|
|
779
|
+
rawNames: ["mcporter"]
|
|
780
|
+
},
|
|
781
|
+
{
|
|
782
|
+
id: "rmcp",
|
|
783
|
+
label: "rmcp",
|
|
784
|
+
vendor: "mcp",
|
|
785
|
+
rawNames: ["rmcp"]
|
|
786
|
+
},
|
|
787
|
+
{
|
|
788
|
+
id: "unnamed_client",
|
|
789
|
+
label: "Unnamed client",
|
|
790
|
+
vendor: "mcp",
|
|
791
|
+
rawNames: [
|
|
792
|
+
"mcp",
|
|
793
|
+
"unknown",
|
|
794
|
+
""
|
|
795
|
+
]
|
|
796
|
+
}
|
|
797
|
+
];
|
|
798
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
799
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
800
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
801
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
491
802
|
const runtimeSchema = z.enum([
|
|
492
803
|
"python3.13",
|
|
493
804
|
"python3.14",
|
|
@@ -513,6 +824,7 @@ z.object({
|
|
|
513
824
|
buildOutputDir: z.string().nullable(),
|
|
514
825
|
startCommand: z.string().nullable(),
|
|
515
826
|
fixedOutboundIp: z.boolean(),
|
|
827
|
+
excludedUserIds: z.array(z.string().trim().min(1).max(512)).default([]),
|
|
516
828
|
environments: z.array(environmentWithDomainsSchema),
|
|
517
829
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
518
830
|
});
|
|
@@ -565,15 +877,7 @@ z.object({
|
|
|
565
877
|
serverFields: serverFieldsSchema$1,
|
|
566
878
|
source: z.enum(["registry", "defaults"])
|
|
567
879
|
});
|
|
568
|
-
/**
|
|
569
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
570
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
571
|
-
*
|
|
572
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
573
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
574
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
575
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
576
|
-
*/
|
|
880
|
+
/** 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. */
|
|
577
881
|
const clampStringField = (field) => {
|
|
578
882
|
const max = field.maxLength;
|
|
579
883
|
if (max === null) return field;
|
|
@@ -581,6 +885,10 @@ const clampStringField = (field) => {
|
|
|
581
885
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
582
886
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
583
887
|
};
|
|
888
|
+
const unboundedArrayField = (field) => {
|
|
889
|
+
const unbounded = z.array(field.element);
|
|
890
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
891
|
+
};
|
|
584
892
|
const toolDefinitionSchema = z.object({
|
|
585
893
|
name: z.string(),
|
|
586
894
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -593,11 +901,22 @@ const toolDefinitionSchema = z.object({
|
|
|
593
901
|
}).optional()
|
|
594
902
|
});
|
|
595
903
|
const positiveTestCaseSchema = z.object({
|
|
596
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
597
|
-
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."),
|
|
904
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
905
|
+
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."),
|
|
598
906
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
599
907
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
600
|
-
}).
|
|
908
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
909
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
910
|
+
scenario: z.string().optional(),
|
|
911
|
+
userPrompt: z.string().optional()
|
|
912
|
+
});
|
|
913
|
+
const blankPositiveTestCase = () => ({
|
|
914
|
+
scenario: "",
|
|
915
|
+
userPrompt: "",
|
|
916
|
+
toolTriggered: "",
|
|
917
|
+
expectedOutput: ""
|
|
918
|
+
});
|
|
919
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
601
920
|
const screenshotEntrySchema = z.object({
|
|
602
921
|
prompt: z.string(),
|
|
603
922
|
url: z.url()
|
|
@@ -910,20 +1229,25 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
910
1229
|
"zh-TW"
|
|
911
1230
|
]);
|
|
912
1231
|
const negativeTestCaseSchema = z.object({
|
|
913
|
-
scenario: z.string(),
|
|
914
|
-
userPrompt: z.string()
|
|
915
|
-
}).
|
|
1232
|
+
scenario: z.string().min(1),
|
|
1233
|
+
userPrompt: z.string().min(1)
|
|
1234
|
+
}).describe("Each case: Scenario + User prompt (the plugin should NOT trigger).");
|
|
1235
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1236
|
+
scenario: z.string().optional(),
|
|
1237
|
+
userPrompt: z.string().optional()
|
|
1238
|
+
});
|
|
1239
|
+
const blankNegativeTestCase = () => ({
|
|
1240
|
+
scenario: "",
|
|
1241
|
+
userPrompt: ""
|
|
1242
|
+
});
|
|
1243
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
916
1244
|
const chatgptToolJustificationSchema = z.object({
|
|
917
1245
|
toolName: z.string(),
|
|
918
1246
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
919
1247
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
920
1248
|
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.\"")
|
|
921
1249
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
922
|
-
/**
|
|
923
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
924
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
925
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
926
|
-
*/
|
|
1250
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
927
1251
|
const chatgptTaglineSchema = z.string().max(30);
|
|
928
1252
|
const chatgptDescriptionSchema = z.string();
|
|
929
1253
|
const chatgptTranslationSchema = z.object({
|
|
@@ -932,34 +1256,32 @@ const chatgptTranslationSchema = z.object({
|
|
|
932
1256
|
description: chatgptDescriptionSchema
|
|
933
1257
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
934
1258
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
935
|
-
/**
|
|
936
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
937
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
938
|
-
*/
|
|
1259
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
939
1260
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
940
1261
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
941
1262
|
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."),
|
|
942
|
-
appName: z.string().describe("The name users will see in ChatGPT and in the
|
|
1263
|
+
appName: z.string().describe("The name users will see in ChatGPT and in the Plugin Directory."),
|
|
943
1264
|
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
944
|
-
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the
|
|
1265
|
+
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the plugin does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the plugin does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
|
|
945
1266
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
946
|
-
developerName: z.string().describe("Developer name shown publicly on the
|
|
1267
|
+
developerName: z.string().describe("Developer name shown publicly on the plugin's directory page."),
|
|
947
1268
|
companyUrl: urlField.describe("Your company's main website URL."),
|
|
948
1269
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
949
1270
|
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
950
|
-
termsOfServiceUrl: urlField.describe("URL to the
|
|
951
|
-
demoRecordingUrl: urlField.describe("URL to a video demonstrating the
|
|
952
|
-
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My
|
|
1271
|
+
termsOfServiceUrl: urlField.describe("URL to the plugin's terms of service."),
|
|
1272
|
+
demoRecordingUrl: urlField.describe("URL to a video demonstrating the plugin, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
1273
|
+
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My plugin links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the plugin does not offer digital goods."),
|
|
953
1274
|
serverUrl: urlField.describe("URL of the MCP server."),
|
|
954
1275
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
955
1276
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
956
1277
|
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."),
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
|
|
1278
|
+
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."),
|
|
1279
|
+
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."),
|
|
1280
|
+
negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 3 negative test cases: prompts where the plugin should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the plugin does not carry, the right brand or domain but an intent the plugin does not serve, or a boundary with a sibling plugin."),
|
|
1281
|
+
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-plugin screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget plugins must show the widget UI; non-widget plugins show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
960
1282
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
961
1283
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
962
|
-
releaseNotes: z.string().describe("Publicly displayed on the
|
|
1284
|
+
releaseNotes: z.string().describe("Publicly displayed on the plugin details page.")
|
|
963
1285
|
});
|
|
964
1286
|
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
965
1287
|
tagline: z.string().optional(),
|
|
@@ -970,23 +1292,35 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
970
1292
|
demoRecordingUrl: z.string().optional(),
|
|
971
1293
|
serverUrl: z.string().optional(),
|
|
972
1294
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1295
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1296
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
973
1297
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
974
1298
|
});
|
|
975
|
-
|
|
1299
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1300
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
976
1301
|
appName: true,
|
|
977
1302
|
developerName: true,
|
|
978
1303
|
serverUrl: true,
|
|
979
1304
|
tools: true,
|
|
1305
|
+
skills: true,
|
|
980
1306
|
authentication: true
|
|
981
1307
|
});
|
|
982
|
-
|
|
1308
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1309
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
983
1310
|
tagline: true,
|
|
984
1311
|
description: true,
|
|
985
1312
|
category: true,
|
|
986
1313
|
testCases: true,
|
|
987
1314
|
negativeTestCases: true,
|
|
988
1315
|
toolJustifications: true
|
|
989
|
-
}).extend({
|
|
1316
|
+
}).extend({
|
|
1317
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1318
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1319
|
+
}).extend({
|
|
1320
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1321
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1322
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1323
|
+
});
|
|
990
1324
|
const claudeCategorySchema = z.enum([
|
|
991
1325
|
"Productivity",
|
|
992
1326
|
"Communication",
|
|
@@ -1032,11 +1366,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1032
1366
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1033
1367
|
"Public documentation for this connector will be live by the publish date."
|
|
1034
1368
|
]);
|
|
1035
|
-
/**
|
|
1036
|
-
* Field order mirrors the claude.ai directory submission wizard
|
|
1037
|
-
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1038
|
-
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1039
|
-
*/
|
|
1369
|
+
/** 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. */
|
|
1040
1370
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1041
1371
|
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
|
|
1042
1372
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1113,7 +1443,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1113
1443
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1114
1444
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1115
1445
|
});
|
|
1116
|
-
|
|
1446
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1447
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1117
1448
|
serverUrl: true,
|
|
1118
1449
|
name: true,
|
|
1119
1450
|
slug: true,
|
|
@@ -1128,39 +1459,93 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1128
1459
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1129
1460
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1130
1461
|
});
|
|
1131
|
-
/**
|
|
1132
|
-
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1133
|
-
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1134
|
-
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1135
|
-
* colocated with the Claude contract.
|
|
1136
|
-
*/
|
|
1462
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1137
1463
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1138
1464
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1139
1465
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1140
1466
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1141
1467
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1142
1468
|
});
|
|
1143
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1469
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1144
1470
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1145
1471
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1146
1472
|
});
|
|
1473
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1474
|
+
const byField = {};
|
|
1475
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1476
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1477
|
+
return byField;
|
|
1478
|
+
}
|
|
1479
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1480
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1481
|
+
"pass",
|
|
1482
|
+
"fail",
|
|
1483
|
+
"unverified"
|
|
1484
|
+
]);
|
|
1485
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1486
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1487
|
+
claudeai: ["privacyPolicy"]
|
|
1488
|
+
};
|
|
1489
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1490
|
+
const policyDisclosureSchema = z.enum([
|
|
1491
|
+
"dataCategories",
|
|
1492
|
+
"purposesOfUse",
|
|
1493
|
+
"recipients",
|
|
1494
|
+
"retention"
|
|
1495
|
+
]);
|
|
1496
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1497
|
+
field: verifiableUrlFieldSchema,
|
|
1498
|
+
url: z.string(),
|
|
1499
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1500
|
+
reason: z.string(),
|
|
1501
|
+
concerns: z.array(z.string()).optional(),
|
|
1502
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1503
|
+
});
|
|
1504
|
+
const urlVerificationSchema = z.object({
|
|
1505
|
+
verifiedAt: z.coerce.date(),
|
|
1506
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1507
|
+
});
|
|
1508
|
+
const pageKindSchema = z.enum([
|
|
1509
|
+
"expectedDocument",
|
|
1510
|
+
"errorPage",
|
|
1511
|
+
"loginWall",
|
|
1512
|
+
"parkedDomain",
|
|
1513
|
+
"comingSoon",
|
|
1514
|
+
"marketingPage",
|
|
1515
|
+
"unrelatedDocument"
|
|
1516
|
+
]);
|
|
1517
|
+
z.object({
|
|
1518
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1519
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1520
|
+
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.")
|
|
1521
|
+
});
|
|
1147
1522
|
const submissionMetaFieldsSchema = z.object({
|
|
1148
1523
|
id: z.string(),
|
|
1149
1524
|
environmentId: z.string(),
|
|
1150
1525
|
auditId: z.string().nullable(),
|
|
1526
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1151
1527
|
createdAt: z.coerce.date(),
|
|
1152
1528
|
updatedAt: z.coerce.date()
|
|
1153
1529
|
});
|
|
1154
1530
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1155
1531
|
platform: z.literal("claudeai"),
|
|
1156
|
-
formData: claudeSubmissionDraftSchema
|
|
1532
|
+
formData: claudeSubmissionDraftSchema,
|
|
1533
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1157
1534
|
});
|
|
1158
1535
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1159
1536
|
platform: z.literal("chatgpt"),
|
|
1160
|
-
formData: chatgptSubmissionDraftSchema
|
|
1537
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1538
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1161
1539
|
});
|
|
1162
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1540
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1163
1541
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1542
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1543
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1544
|
+
z.literal([
|
|
1545
|
+
100,
|
|
1546
|
+
75,
|
|
1547
|
+
50
|
|
1548
|
+
]);
|
|
1164
1549
|
const subscriptionPlanSchema = z.enum([
|
|
1165
1550
|
"pro",
|
|
1166
1551
|
"business",
|
|
@@ -1172,17 +1557,78 @@ const customerCreditsSchema = z.object({
|
|
|
1172
1557
|
expiresAt: z.number().nullable(),
|
|
1173
1558
|
currency: z.string()
|
|
1174
1559
|
});
|
|
1175
|
-
const customerUsageSchema = z.object({
|
|
1176
|
-
amountInCents: z.number(),
|
|
1177
|
-
currency: z.string(),
|
|
1178
|
-
periodEnd: z.number()
|
|
1179
|
-
});
|
|
1180
1560
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1181
1561
|
z.object({
|
|
1182
1562
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1183
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1184
1563
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1185
1564
|
});
|
|
1565
|
+
const metricsQueueEventSchema = z.object({
|
|
1566
|
+
ts: z.number().int(),
|
|
1567
|
+
method: z.string(),
|
|
1568
|
+
tool: z.string().nullable(),
|
|
1569
|
+
client: z.string(),
|
|
1570
|
+
sessionId: z.string().nullable(),
|
|
1571
|
+
conversationId: z.string().nullable().optional(),
|
|
1572
|
+
durationMs: z.number().int(),
|
|
1573
|
+
outputTokens: z.number().int().nullable(),
|
|
1574
|
+
errorType: z.enum([
|
|
1575
|
+
"mcp_error",
|
|
1576
|
+
"tool_error",
|
|
1577
|
+
"timeout"
|
|
1578
|
+
]).nullable(),
|
|
1579
|
+
errorCode: z.number().int().nullable()
|
|
1580
|
+
});
|
|
1581
|
+
z.object({
|
|
1582
|
+
v: z.literal(1),
|
|
1583
|
+
envId: z.string(),
|
|
1584
|
+
events: z.array(metricsQueueEventSchema)
|
|
1585
|
+
});
|
|
1586
|
+
z.object({ v: z.number() });
|
|
1587
|
+
const TELEMETRY_SIGNALS = [
|
|
1588
|
+
"logs",
|
|
1589
|
+
"metrics",
|
|
1590
|
+
"traces"
|
|
1591
|
+
];
|
|
1592
|
+
const telemetrySignalSchema = z.enum(TELEMETRY_SIGNALS);
|
|
1593
|
+
const OTLP_PROTOCOLS = ["http/protobuf", "http/json"];
|
|
1594
|
+
const otlpProtocolSchema = z.enum(OTLP_PROTOCOLS);
|
|
1595
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1596
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1597
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1598
|
+
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");
|
|
1599
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1600
|
+
id: z.string(),
|
|
1601
|
+
name: otlpHeaderNameSchema,
|
|
1602
|
+
value: otlpHeaderValueSchema,
|
|
1603
|
+
isSecret: z.boolean()
|
|
1604
|
+
});
|
|
1605
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1606
|
+
"credentials",
|
|
1607
|
+
"wrong-path",
|
|
1608
|
+
"wrong-protocol",
|
|
1609
|
+
"invalid-payload",
|
|
1610
|
+
"partial-rejection",
|
|
1611
|
+
"blocked-target",
|
|
1612
|
+
"timeout",
|
|
1613
|
+
"unreachable",
|
|
1614
|
+
"receiver-error",
|
|
1615
|
+
"unexpected-status"
|
|
1616
|
+
]);
|
|
1617
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1618
|
+
z.object({
|
|
1619
|
+
id: z.string(),
|
|
1620
|
+
signal: telemetrySignalSchema,
|
|
1621
|
+
endpoint: otlpEndpointSchema,
|
|
1622
|
+
protocol: otlpProtocolSchema,
|
|
1623
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1624
|
+
status: telemetryDestinationStatusSchema,
|
|
1625
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable(),
|
|
1626
|
+
isScopedToIntentionalRequestsOnly: z.boolean()
|
|
1627
|
+
});
|
|
1628
|
+
const hasDuplicateHeaderNames = (headers) => {
|
|
1629
|
+
const names = headers.map(({ name }) => name.trim().toLowerCase());
|
|
1630
|
+
return new Set(names).size !== names.length;
|
|
1631
|
+
};
|
|
1186
1632
|
//#endregion
|
|
1187
1633
|
//#region src/auth-scope.ts
|
|
1188
1634
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1225,7 +1671,10 @@ const RESERVED_KEYS = [
|
|
|
1225
1671
|
"BUILD_ARG_START_COMMAND",
|
|
1226
1672
|
"ALPIC_HOST",
|
|
1227
1673
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1228
|
-
"ALPIC_INTENT_META_KEY"
|
|
1674
|
+
"ALPIC_INTENT_META_KEY",
|
|
1675
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1676
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1677
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1229
1678
|
];
|
|
1230
1679
|
const environmentVariableSchema = z.object({
|
|
1231
1680
|
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"),
|
|
@@ -1278,6 +1727,14 @@ const serverFieldsSchema = z.object({
|
|
|
1278
1727
|
});
|
|
1279
1728
|
//#endregion
|
|
1280
1729
|
//#region src/api.contract.ts
|
|
1730
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1731
|
+
try {
|
|
1732
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1733
|
+
return true;
|
|
1734
|
+
} catch {
|
|
1735
|
+
return false;
|
|
1736
|
+
}
|
|
1737
|
+
};
|
|
1281
1738
|
const deploymentStatusSchema = z.enum([
|
|
1282
1739
|
"ongoing",
|
|
1283
1740
|
"deployed",
|
|
@@ -1306,21 +1763,20 @@ const deploymentSchema = z.object({
|
|
|
1306
1763
|
isCurrent: z.boolean(),
|
|
1307
1764
|
deploymentPageUrl: z.url().nullable()
|
|
1308
1765
|
});
|
|
1309
|
-
const
|
|
1766
|
+
const isValidTimeInput = (value) => {
|
|
1310
1767
|
if (ms(value) !== void 0) return true;
|
|
1311
1768
|
return !Number.isNaN(new Date(value).getTime());
|
|
1312
1769
|
};
|
|
1313
|
-
const
|
|
1770
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1771
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1772
|
+
const createEnvironmentContractV1 = base.route({
|
|
1314
1773
|
path: "/v1/environments",
|
|
1315
1774
|
method: "POST",
|
|
1316
1775
|
summary: "Create an environment",
|
|
1317
1776
|
description: "Create an environment for a project",
|
|
1318
1777
|
tags: ["environments"],
|
|
1319
1778
|
successDescription: "The environment has been created successfully"
|
|
1320
|
-
}).errors({
|
|
1321
|
-
NOT_FOUND: {},
|
|
1322
|
-
BAD_REQUEST: {}
|
|
1323
|
-
}).input(z.object({
|
|
1779
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1324
1780
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1325
1781
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1326
1782
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1333,7 +1789,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1333
1789
|
createdAt: z.coerce.date(),
|
|
1334
1790
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1335
1791
|
}));
|
|
1336
|
-
const getEnvironmentContractV1 =
|
|
1792
|
+
const getEnvironmentContractV1 = base.route({
|
|
1337
1793
|
path: "/v1/environments/{environmentId}",
|
|
1338
1794
|
method: "GET",
|
|
1339
1795
|
summary: "Get an environment",
|
|
@@ -1349,6 +1805,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1349
1805
|
createdAt: z.coerce.date(),
|
|
1350
1806
|
projectId: z.string()
|
|
1351
1807
|
}));
|
|
1808
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1809
|
+
path: "/v1/environments/{environmentId}",
|
|
1810
|
+
method: "DELETE",
|
|
1811
|
+
summary: "Delete an environment",
|
|
1812
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1813
|
+
tags: ["environments"],
|
|
1814
|
+
successDescription: "The environment has been deleted successfully"
|
|
1815
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1352
1816
|
const domainSchema = z.object({
|
|
1353
1817
|
domain: z.string(),
|
|
1354
1818
|
status: z.enum([
|
|
@@ -1390,7 +1854,7 @@ const projectOutputSchema = z.object({
|
|
|
1390
1854
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1391
1855
|
environments: z.array(environmentSchema)
|
|
1392
1856
|
});
|
|
1393
|
-
const getProjectContractV1 =
|
|
1857
|
+
const getProjectContractV1 = base.route({
|
|
1394
1858
|
path: "/v1/projects/{projectId}",
|
|
1395
1859
|
method: "GET",
|
|
1396
1860
|
summary: "Get a project",
|
|
@@ -1398,18 +1862,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1398
1862
|
tags: ["projects"],
|
|
1399
1863
|
successDescription: "The project details"
|
|
1400
1864
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1401
|
-
const listProjectsContractV1 =
|
|
1865
|
+
const listProjectsContractV1 = base.route({
|
|
1402
1866
|
path: "/v1/projects",
|
|
1403
1867
|
method: "GET",
|
|
1404
1868
|
summary: "List projects",
|
|
1405
1869
|
description: "List all projects for a team",
|
|
1406
1870
|
tags: ["projects"],
|
|
1407
1871
|
successDescription: "The list of projects"
|
|
1408
|
-
}).errors({
|
|
1409
|
-
|
|
1410
|
-
BAD_REQUEST: {}
|
|
1411
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1412
|
-
const createProjectContractV1 = oc.route({
|
|
1872
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1873
|
+
const createProjectContractV1 = base.route({
|
|
1413
1874
|
path: "/v1/projects",
|
|
1414
1875
|
method: "POST",
|
|
1415
1876
|
summary: "Create a project",
|
|
@@ -1418,7 +1879,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1418
1879
|
successDescription: "The project has been created successfully"
|
|
1419
1880
|
}).errors({
|
|
1420
1881
|
NOT_FOUND: {},
|
|
1421
|
-
BAD_REQUEST: {},
|
|
1422
1882
|
FORBIDDEN: {}
|
|
1423
1883
|
}).input(z.object({
|
|
1424
1884
|
teamId: z.string().optional(),
|
|
@@ -1459,7 +1919,101 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1459
1919
|
isSecret: z.boolean(),
|
|
1460
1920
|
createdAt: z.coerce.date()
|
|
1461
1921
|
});
|
|
1462
|
-
const
|
|
1922
|
+
const telemetryDestinationHeaderOutputSchema = z.discriminatedUnion("isSecret", [z.object({
|
|
1923
|
+
id: z.string(),
|
|
1924
|
+
name: otlpHeaderNameSchema,
|
|
1925
|
+
value: z.null(),
|
|
1926
|
+
isSecret: z.literal(true)
|
|
1927
|
+
}), z.object({
|
|
1928
|
+
id: z.string(),
|
|
1929
|
+
name: otlpHeaderNameSchema,
|
|
1930
|
+
value: otlpHeaderValueSchema,
|
|
1931
|
+
isSecret: z.literal(false)
|
|
1932
|
+
})]);
|
|
1933
|
+
const telemetryDestinationOutputSchema = z.object({
|
|
1934
|
+
id: z.string(),
|
|
1935
|
+
signal: telemetrySignalSchema,
|
|
1936
|
+
endpoint: otlpEndpointSchema,
|
|
1937
|
+
protocol: otlpProtocolSchema,
|
|
1938
|
+
headers: z.array(telemetryDestinationHeaderOutputSchema),
|
|
1939
|
+
status: telemetryDestinationStatusSchema,
|
|
1940
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable(),
|
|
1941
|
+
isScopedToIntentionalRequestsOnly: z.boolean()
|
|
1942
|
+
});
|
|
1943
|
+
const createTelemetryDestinationHeaderInputSchema = z.object({
|
|
1944
|
+
name: otlpHeaderNameSchema,
|
|
1945
|
+
value: otlpHeaderValueSchema.min(1, "Enter a header value"),
|
|
1946
|
+
isSecret: z.boolean()
|
|
1947
|
+
});
|
|
1948
|
+
const updateTelemetryDestinationHeaderInputSchema = z.object({
|
|
1949
|
+
id: z.string().optional(),
|
|
1950
|
+
name: otlpHeaderNameSchema,
|
|
1951
|
+
value: otlpHeaderValueSchema.optional(),
|
|
1952
|
+
isSecret: z.boolean()
|
|
1953
|
+
});
|
|
1954
|
+
const uniqueTelemetryHeaders = (headers) => !hasDuplicateHeaderNames(headers);
|
|
1955
|
+
const listTelemetryDestinationsContractV1 = base.route({
|
|
1956
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations",
|
|
1957
|
+
method: "GET",
|
|
1958
|
+
summary: "List telemetry destinations",
|
|
1959
|
+
description: "List the OTLP destinations configured for an environment. Secret header values are never returned.",
|
|
1960
|
+
tags: ["telemetry"],
|
|
1961
|
+
successDescription: "The list of telemetry destinations"
|
|
1962
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(telemetryDestinationOutputSchema));
|
|
1963
|
+
const createTelemetryDestinationContractV1 = base.route({
|
|
1964
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations",
|
|
1965
|
+
method: "POST",
|
|
1966
|
+
summary: "Create a telemetry destination",
|
|
1967
|
+
description: "Verify and save an OTLP destination for logs, metrics, or traces.",
|
|
1968
|
+
tags: ["telemetry"],
|
|
1969
|
+
successDescription: "The telemetry destination has been created"
|
|
1970
|
+
}).errors({
|
|
1971
|
+
NOT_FOUND: {},
|
|
1972
|
+
FORBIDDEN: {},
|
|
1973
|
+
OTLP_DESTINATION_UNVERIFIED: { status: 400 },
|
|
1974
|
+
INTERNAL_SERVER_ERROR: {}
|
|
1975
|
+
}).input(z.object({
|
|
1976
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1977
|
+
signal: telemetrySignalSchema,
|
|
1978
|
+
endpoint: otlpEndpointSchema,
|
|
1979
|
+
protocol: otlpProtocolSchema.default("http/protobuf"),
|
|
1980
|
+
isScopedToIntentionalRequestsOnly: z.boolean().default(false),
|
|
1981
|
+
headers: z.array(createTelemetryDestinationHeaderInputSchema).default([]).refine(uniqueTelemetryHeaders, "Header names must be unique")
|
|
1982
|
+
})).output(telemetryDestinationOutputSchema);
|
|
1983
|
+
const updateTelemetryDestinationContractV1 = base.route({
|
|
1984
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations/{destinationId}",
|
|
1985
|
+
method: "PATCH",
|
|
1986
|
+
summary: "Update a telemetry destination",
|
|
1987
|
+
description: "Verify and save changes to an OTLP destination. Omit headers to keep them unchanged; omit the value of an existing header to preserve it. A secret header value must be re-entered when the endpoint changes.",
|
|
1988
|
+
tags: ["telemetry"],
|
|
1989
|
+
successDescription: "The telemetry destination has been updated"
|
|
1990
|
+
}).errors({
|
|
1991
|
+
NOT_FOUND: {},
|
|
1992
|
+
FORBIDDEN: {},
|
|
1993
|
+
OTLP_DESTINATION_UNVERIFIED: { status: 400 }
|
|
1994
|
+
}).input(z.object({
|
|
1995
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1996
|
+
destinationId: z.string().describe("The ID of the telemetry destination"),
|
|
1997
|
+
endpoint: otlpEndpointSchema.optional(),
|
|
1998
|
+
protocol: otlpProtocolSchema.optional(),
|
|
1999
|
+
isScopedToIntentionalRequestsOnly: z.boolean().optional(),
|
|
2000
|
+
headers: z.array(updateTelemetryDestinationHeaderInputSchema).refine(uniqueTelemetryHeaders, "Header names must be unique").optional()
|
|
2001
|
+
})).output(telemetryDestinationOutputSchema);
|
|
2002
|
+
const deleteTelemetryDestinationContractV1 = base.route({
|
|
2003
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations/{destinationId}",
|
|
2004
|
+
method: "DELETE",
|
|
2005
|
+
summary: "Delete a telemetry destination",
|
|
2006
|
+
description: "Delete an OTLP destination from an environment.",
|
|
2007
|
+
tags: ["telemetry"],
|
|
2008
|
+
successDescription: "The telemetry destination has been deleted"
|
|
2009
|
+
}).errors({
|
|
2010
|
+
NOT_FOUND: {},
|
|
2011
|
+
INTERNAL_SERVER_ERROR: {}
|
|
2012
|
+
}).input(z.object({
|
|
2013
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2014
|
+
destinationId: z.string().describe("The ID of the telemetry destination")
|
|
2015
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2016
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1463
2017
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1464
2018
|
method: "GET",
|
|
1465
2019
|
summary: "List environment variables",
|
|
@@ -1467,48 +2021,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1467
2021
|
tags: ["environments"],
|
|
1468
2022
|
successDescription: "The list of environment variables"
|
|
1469
2023
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1470
|
-
const createEnvironmentVariablesContractV1 =
|
|
2024
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1471
2025
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1472
2026
|
method: "POST",
|
|
1473
2027
|
summary: "Add environment variables",
|
|
1474
2028
|
description: "Add one or more environment variables to an environment",
|
|
1475
2029
|
tags: ["environments"],
|
|
1476
2030
|
successDescription: "The environment variables have been added successfully"
|
|
1477
|
-
}).errors({
|
|
1478
|
-
NOT_FOUND: {},
|
|
1479
|
-
BAD_REQUEST: {}
|
|
1480
|
-
}).input(z.object({
|
|
2031
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1481
2032
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1482
2033
|
environmentVariables: environmentVariablesSchema
|
|
1483
2034
|
})).output(z.object({ success: z.literal(true) }));
|
|
1484
|
-
const updateEnvironmentVariableContractV1 =
|
|
2035
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1485
2036
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1486
2037
|
method: "PATCH",
|
|
1487
2038
|
summary: "Update an environment variable",
|
|
1488
2039
|
description: "Update an environment variable by ID",
|
|
1489
2040
|
tags: ["environments"],
|
|
1490
2041
|
successDescription: "The environment variable has been updated successfully"
|
|
1491
|
-
}).errors({
|
|
1492
|
-
NOT_FOUND: {},
|
|
1493
|
-
BAD_REQUEST: {}
|
|
1494
|
-
}).input(z.object({
|
|
2042
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1495
2043
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1496
2044
|
key: environmentVariableSchema.shape.key,
|
|
1497
2045
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1498
2046
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1499
2047
|
})).output(z.object({ success: z.literal(true) }));
|
|
1500
|
-
const deleteEnvironmentVariableContractV1 =
|
|
2048
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1501
2049
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1502
2050
|
method: "DELETE",
|
|
1503
2051
|
summary: "Delete an environment variable",
|
|
1504
2052
|
description: "Delete an environment variable by ID",
|
|
1505
2053
|
tags: ["environments"],
|
|
1506
2054
|
successDescription: "The environment variable has been deleted successfully"
|
|
1507
|
-
}).errors({
|
|
1508
|
-
|
|
1509
|
-
BAD_REQUEST: {}
|
|
1510
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1511
|
-
const deleteProjectContractV1 = oc.route({
|
|
2055
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
2056
|
+
const deleteProjectContractV1 = base.route({
|
|
1512
2057
|
path: "/v1/projects/{projectId}",
|
|
1513
2058
|
method: "DELETE",
|
|
1514
2059
|
summary: "Delete a project",
|
|
@@ -1516,7 +2061,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1516
2061
|
tags: ["projects"],
|
|
1517
2062
|
successDescription: "The project has been deleted successfully"
|
|
1518
2063
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1519
|
-
const updateProjectContractV1 =
|
|
2064
|
+
const updateProjectContractV1 = base.route({
|
|
1520
2065
|
path: "/v1/projects/{projectId}",
|
|
1521
2066
|
method: "PATCH",
|
|
1522
2067
|
summary: "Update a project",
|
|
@@ -1525,14 +2070,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1525
2070
|
successDescription: "The project has been updated successfully"
|
|
1526
2071
|
}).errors({
|
|
1527
2072
|
NOT_FOUND: {},
|
|
1528
|
-
BAD_REQUEST: {},
|
|
1529
2073
|
FORBIDDEN: {}
|
|
1530
2074
|
}).input(z.object({
|
|
1531
2075
|
projectId: z.string().describe("The ID of the project"),
|
|
1532
2076
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1533
2077
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1534
2078
|
})).output(projectOutputSchema);
|
|
1535
|
-
const deployEnvironmentContractV1 =
|
|
2079
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1536
2080
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1537
2081
|
method: "POST",
|
|
1538
2082
|
summary: "Deploy an environment",
|
|
@@ -1541,28 +2085,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1541
2085
|
successDescription: "The environment has been deployed successfully"
|
|
1542
2086
|
}).errors({
|
|
1543
2087
|
NOT_FOUND: {},
|
|
1544
|
-
|
|
2088
|
+
CONFLICT: {}
|
|
1545
2089
|
}).input(z.object({
|
|
1546
2090
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1547
2091
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1548
2092
|
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.")
|
|
1549
2093
|
})).output(deploymentSchema);
|
|
1550
|
-
const uploadDeploymentArtifactContractV1 =
|
|
2094
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1551
2095
|
path: "/v1/deployments/upload",
|
|
1552
2096
|
method: "POST",
|
|
1553
2097
|
summary: "Upload deployment artifacts",
|
|
1554
2098
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1555
2099
|
tags: ["deployments"],
|
|
1556
2100
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1557
|
-
}).errors({
|
|
1558
|
-
NOT_FOUND: {},
|
|
1559
|
-
BAD_REQUEST: {}
|
|
1560
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
2101
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1561
2102
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1562
2103
|
token: z.string().describe("Token to identify the source archive"),
|
|
1563
2104
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1564
2105
|
}));
|
|
1565
|
-
const listDeploymentsContractV1 =
|
|
2106
|
+
const listDeploymentsContractV1 = base.route({
|
|
1566
2107
|
path: "/v1/projects/{projectId}/deployments",
|
|
1567
2108
|
method: "GET",
|
|
1568
2109
|
summary: "List project deployments",
|
|
@@ -1574,7 +2115,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1574
2115
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1575
2116
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1576
2117
|
})).output(z.array(deploymentSchema));
|
|
1577
|
-
const getDeploymentContractV1 =
|
|
2118
|
+
const getDeploymentContractV1 = base.route({
|
|
1578
2119
|
path: "/v1/deployments/{deploymentId}",
|
|
1579
2120
|
method: "GET",
|
|
1580
2121
|
summary: "Get a deployment",
|
|
@@ -1582,20 +2123,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1582
2123
|
tags: ["deployments"],
|
|
1583
2124
|
successDescription: "The deployment details"
|
|
1584
2125
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1585
|
-
const
|
|
2126
|
+
const logEntrySchema = z.object({
|
|
2127
|
+
timestamp: z.coerce.date(),
|
|
2128
|
+
type: z.enum([
|
|
2129
|
+
"START",
|
|
2130
|
+
"END",
|
|
2131
|
+
"INFO",
|
|
2132
|
+
"ERROR",
|
|
2133
|
+
"WARNING",
|
|
2134
|
+
"DEBUG"
|
|
2135
|
+
]),
|
|
2136
|
+
requestId: z.string(),
|
|
2137
|
+
content: z.string().optional(),
|
|
2138
|
+
method: z.string().optional(),
|
|
2139
|
+
durationInMs: z.number().optional()
|
|
2140
|
+
});
|
|
2141
|
+
const getLogsContractV1 = base.route({
|
|
1586
2142
|
path: "/v1/environments/{environmentId}/logs",
|
|
1587
2143
|
method: "GET",
|
|
1588
2144
|
summary: "Get logs",
|
|
1589
2145
|
description: "Get logs for an environment",
|
|
1590
2146
|
tags: ["environments"],
|
|
1591
2147
|
successDescription: "The logs"
|
|
1592
|
-
}).errors({
|
|
1593
|
-
NOT_FOUND: {},
|
|
1594
|
-
BAD_REQUEST: {}
|
|
1595
|
-
}).input(z.object({
|
|
2148
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1596
2149
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1597
|
-
since:
|
|
1598
|
-
until:
|
|
2150
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2151
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1599
2152
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1600
2153
|
level: z.array(z.enum([
|
|
1601
2154
|
"INFO",
|
|
@@ -1603,37 +2156,20 @@ const getLogsContractV1 = oc.route({
|
|
|
1603
2156
|
"WARNING",
|
|
1604
2157
|
"DEBUG"
|
|
1605
2158
|
])).optional().describe("Filter by log level"),
|
|
1606
|
-
search:
|
|
2159
|
+
search: logSearchSchema.optional().describe("Term to search for in log content"),
|
|
1607
2160
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1608
2161
|
})).output(z.object({
|
|
1609
|
-
logs: z.array(
|
|
1610
|
-
timestamp: z.coerce.date(),
|
|
1611
|
-
type: z.enum([
|
|
1612
|
-
"START",
|
|
1613
|
-
"END",
|
|
1614
|
-
"INFO",
|
|
1615
|
-
"ERROR",
|
|
1616
|
-
"WARNING",
|
|
1617
|
-
"DEBUG"
|
|
1618
|
-
]),
|
|
1619
|
-
requestId: z.string(),
|
|
1620
|
-
content: z.string().optional(),
|
|
1621
|
-
method: z.string().optional(),
|
|
1622
|
-
durationInMs: z.number().optional()
|
|
1623
|
-
})),
|
|
2162
|
+
logs: z.array(logEntrySchema),
|
|
1624
2163
|
nextToken: z.string().nullable()
|
|
1625
2164
|
}));
|
|
1626
|
-
const getLatestLogsContractV1 =
|
|
2165
|
+
const getLatestLogsContractV1 = base.route({
|
|
1627
2166
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1628
2167
|
method: "GET",
|
|
1629
2168
|
summary: "Get latest logs",
|
|
1630
2169
|
description: "Get the N most recent logs for an environment",
|
|
1631
2170
|
tags: ["environments"],
|
|
1632
2171
|
successDescription: "The latest logs"
|
|
1633
|
-
}).errors({
|
|
1634
|
-
NOT_FOUND: {},
|
|
1635
|
-
BAD_REQUEST: {}
|
|
1636
|
-
}).input(z.object({
|
|
2172
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1637
2173
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1638
2174
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1639
2175
|
level: z.array(z.enum([
|
|
@@ -1642,23 +2178,9 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1642
2178
|
"WARNING",
|
|
1643
2179
|
"DEBUG"
|
|
1644
2180
|
])).optional().describe("Filter by log level"),
|
|
1645
|
-
search:
|
|
1646
|
-
})).output(z.object({ logs: z.array(
|
|
1647
|
-
|
|
1648
|
-
type: z.enum([
|
|
1649
|
-
"START",
|
|
1650
|
-
"END",
|
|
1651
|
-
"INFO",
|
|
1652
|
-
"ERROR",
|
|
1653
|
-
"WARNING",
|
|
1654
|
-
"DEBUG"
|
|
1655
|
-
]),
|
|
1656
|
-
requestId: z.string(),
|
|
1657
|
-
content: z.string().optional(),
|
|
1658
|
-
method: z.string().optional(),
|
|
1659
|
-
durationInMs: z.number().optional()
|
|
1660
|
-
})) }));
|
|
1661
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
2181
|
+
search: logSearchSchema.optional().describe("Term to search for in log content")
|
|
2182
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
2183
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1662
2184
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1663
2185
|
method: "GET",
|
|
1664
2186
|
summary: "Get deployment logs",
|
|
@@ -1685,22 +2207,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1685
2207
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1686
2208
|
task_count: z.array(analyticsDataPointSchema)
|
|
1687
2209
|
});
|
|
1688
|
-
const getProjectAnalyticsContractV1 =
|
|
2210
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1689
2211
|
path: "/v1/analytics/{projectId}",
|
|
1690
2212
|
method: "GET",
|
|
1691
2213
|
summary: "Get project analytics",
|
|
1692
2214
|
description: "Get analytics data for a project over a time range",
|
|
1693
2215
|
tags: ["analytics"],
|
|
1694
2216
|
successDescription: "The project analytics data"
|
|
1695
|
-
}).errors({
|
|
1696
|
-
NOT_FOUND: {},
|
|
1697
|
-
BAD_REQUEST: {}
|
|
1698
|
-
}).input(z.object({
|
|
2217
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1699
2218
|
projectId: z.string().describe("The ID of the project"),
|
|
1700
2219
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1701
2220
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1702
2221
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1703
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2222
|
+
}).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({
|
|
1704
2223
|
metadata: z.object({
|
|
1705
2224
|
startTimestamp: z.number(),
|
|
1706
2225
|
endTimestamp: z.number(),
|
|
@@ -1710,7 +2229,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1710
2229
|
}),
|
|
1711
2230
|
timeSeries: analyticsTimeSeriesSchema
|
|
1712
2231
|
}));
|
|
1713
|
-
const
|
|
2232
|
+
const paginatedInsightsInputShape = {
|
|
2233
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2234
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2235
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2236
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2237
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2238
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2239
|
+
};
|
|
2240
|
+
const listIntentsContractV1 = base.route({
|
|
2241
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2242
|
+
method: "GET",
|
|
2243
|
+
summary: "List intents",
|
|
2244
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2245
|
+
tags: ["insights"],
|
|
2246
|
+
successDescription: "The grouped user intents"
|
|
2247
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2248
|
+
...paginatedInsightsInputShape,
|
|
2249
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2250
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2251
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2252
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2253
|
+
})).output(z.object({
|
|
2254
|
+
intents: z.array(z.object({
|
|
2255
|
+
id: z.string(),
|
|
2256
|
+
intentIds: z.array(z.string()).min(1),
|
|
2257
|
+
environmentId: z.string(),
|
|
2258
|
+
message: z.string(),
|
|
2259
|
+
toolName: z.string(),
|
|
2260
|
+
createdAt: z.coerce.date(),
|
|
2261
|
+
occurrenceCount: z.number().int().positive(),
|
|
2262
|
+
clientName: z.string().nullable(),
|
|
2263
|
+
clientId: z.string().nullable(),
|
|
2264
|
+
categories: z.array(z.object({
|
|
2265
|
+
id: z.string(),
|
|
2266
|
+
name: z.string(),
|
|
2267
|
+
color: intentCategoryColorSchema
|
|
2268
|
+
}))
|
|
2269
|
+
})),
|
|
2270
|
+
totalCount: z.number().int().nonnegative()
|
|
2271
|
+
}));
|
|
2272
|
+
const listFeedbacksContractV1 = base.route({
|
|
2273
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2274
|
+
method: "GET",
|
|
2275
|
+
summary: "List feedbacks",
|
|
2276
|
+
description: "List user feedback for an environment over a time range",
|
|
2277
|
+
tags: ["insights"],
|
|
2278
|
+
successDescription: "The user feedback"
|
|
2279
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2280
|
+
...paginatedInsightsInputShape,
|
|
2281
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2282
|
+
})).output(z.object({
|
|
2283
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2284
|
+
totalCount: z.number().int().nonnegative()
|
|
2285
|
+
}));
|
|
2286
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2287
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2288
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2289
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2290
|
+
method: "GET",
|
|
2291
|
+
summary: "List intent categories",
|
|
2292
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2293
|
+
tags: ["insights"],
|
|
2294
|
+
successDescription: "The intent categories"
|
|
2295
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2296
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2297
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2298
|
+
method: "POST",
|
|
2299
|
+
summary: "Create an intent category",
|
|
2300
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2301
|
+
tags: ["insights"],
|
|
2302
|
+
successDescription: "The created intent category"
|
|
2303
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2304
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2305
|
+
name: intentCategoryNameSchema,
|
|
2306
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2307
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2308
|
+
})).output(intentCategorySchema);
|
|
2309
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2310
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2311
|
+
method: "PATCH",
|
|
2312
|
+
summary: "Update an intent category",
|
|
2313
|
+
description: "Rename or recolor an intent category",
|
|
2314
|
+
tags: ["insights"],
|
|
2315
|
+
successDescription: "The updated intent category"
|
|
2316
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2317
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2318
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2319
|
+
name: intentCategoryNameSchema.optional(),
|
|
2320
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2321
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2322
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2323
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2324
|
+
method: "DELETE",
|
|
2325
|
+
summary: "Delete an intent category",
|
|
2326
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2327
|
+
tags: ["insights"],
|
|
2328
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2329
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2330
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2331
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2332
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2333
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2334
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2335
|
+
method: "POST",
|
|
2336
|
+
summary: "Link an intent category",
|
|
2337
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2338
|
+
tags: ["insights"],
|
|
2339
|
+
successDescription: "The intents have been linked successfully"
|
|
2340
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2341
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2342
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2343
|
+
intentIds: categorizableIntentIdsSchema
|
|
2344
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2345
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2346
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2347
|
+
method: "POST",
|
|
2348
|
+
summary: "Unlink an intent category",
|
|
2349
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2350
|
+
tags: ["insights"],
|
|
2351
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2352
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2353
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2354
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2355
|
+
intentIds: categorizableIntentIdsSchema
|
|
2356
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2357
|
+
const listTeamsContractV1 = base.route({
|
|
1714
2358
|
path: "/v1/teams",
|
|
1715
2359
|
method: "GET",
|
|
1716
2360
|
summary: "List teams",
|
|
@@ -1723,7 +2367,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1723
2367
|
createdAt: z.coerce.date(),
|
|
1724
2368
|
hasStripeAccount: z.boolean()
|
|
1725
2369
|
})));
|
|
1726
|
-
const
|
|
2370
|
+
const getTeamUsageContractV1 = base.route({
|
|
2371
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2372
|
+
method: "GET",
|
|
2373
|
+
summary: "Get team usage",
|
|
2374
|
+
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.",
|
|
2375
|
+
tags: ["teams"],
|
|
2376
|
+
successDescription: "The current billing window usage"
|
|
2377
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2378
|
+
teamId: z.string(),
|
|
2379
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2380
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2381
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2382
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2383
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2384
|
+
}));
|
|
2385
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1727
2386
|
path: "/v1/tunnels/ticket",
|
|
1728
2387
|
method: "GET",
|
|
1729
2388
|
summary: "Get a tunnel ticket",
|
|
@@ -1735,16 +2394,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1735
2394
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1736
2395
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1737
2396
|
}));
|
|
1738
|
-
const publishServerContractV1 =
|
|
2397
|
+
const publishServerContractV1 = base.route({
|
|
1739
2398
|
path: "/v1/distribution/publish",
|
|
1740
2399
|
method: "POST",
|
|
1741
2400
|
summary: "Publish a server to the MCP registry",
|
|
1742
2401
|
tags: ["distribution"],
|
|
1743
2402
|
successDescription: "The server has been published successfully"
|
|
1744
|
-
}).errors({
|
|
1745
|
-
NOT_FOUND: {},
|
|
1746
|
-
BAD_REQUEST: {}
|
|
1747
|
-
}).input(z.object({
|
|
2403
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1748
2404
|
projectId: z.string(),
|
|
1749
2405
|
domain: z.string(),
|
|
1750
2406
|
title: z.string().min(1).max(100),
|
|
@@ -1753,17 +2409,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1753
2409
|
iconSrc: z.url().max(255).optional(),
|
|
1754
2410
|
dryRun: z.boolean().optional()
|
|
1755
2411
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1756
|
-
const getServerInfoContractV1 =
|
|
2412
|
+
const getServerInfoContractV1 = base.route({
|
|
1757
2413
|
path: "/v1/distribution/get",
|
|
1758
2414
|
method: "GET",
|
|
1759
2415
|
summary: "Get server info",
|
|
1760
2416
|
description: "Get info about a server",
|
|
1761
2417
|
tags: ["distribution"],
|
|
1762
2418
|
successDescription: "The server info"
|
|
1763
|
-
}).errors({
|
|
1764
|
-
NOT_FOUND: {},
|
|
1765
|
-
BAD_REQUEST: {}
|
|
1766
|
-
}).input(z.object({
|
|
2419
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1767
2420
|
projectId: z.string(),
|
|
1768
2421
|
domain: z.string()
|
|
1769
2422
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1782,7 +2435,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1782
2435
|
isPlaygroundEnabled: z.boolean(),
|
|
1783
2436
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1784
2437
|
});
|
|
1785
|
-
const getPlaygroundContractV1 =
|
|
2438
|
+
const getPlaygroundContractV1 = base.route({
|
|
1786
2439
|
path: "/v1/environments/{environmentId}/playground",
|
|
1787
2440
|
method: "GET",
|
|
1788
2441
|
summary: "Get playground configuration",
|
|
@@ -1790,17 +2443,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1790
2443
|
tags: ["environments"],
|
|
1791
2444
|
successDescription: "The playground configuration"
|
|
1792
2445
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1793
|
-
const upsertPlaygroundContractV1 =
|
|
2446
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1794
2447
|
path: "/v1/environments/{environmentId}/playground",
|
|
1795
2448
|
method: "PUT",
|
|
1796
2449
|
summary: "Update playground configuration",
|
|
1797
2450
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1798
2451
|
tags: ["environments"],
|
|
1799
2452
|
successDescription: "The updated playground configuration"
|
|
1800
|
-
}).errors({
|
|
1801
|
-
NOT_FOUND: {},
|
|
1802
|
-
BAD_REQUEST: {}
|
|
1803
|
-
}).input(z.object({
|
|
2453
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1804
2454
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1805
2455
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1806
2456
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1808,7 +2458,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1808
2458
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1809
2459
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1810
2460
|
})).output(playgroundOutputSchema);
|
|
1811
|
-
const createBeaconContractV1 =
|
|
2461
|
+
const createBeaconContractV1 = base.route({
|
|
1812
2462
|
path: "/v1/beacon/audits",
|
|
1813
2463
|
method: "POST",
|
|
1814
2464
|
summary: "Create a beacon audit",
|
|
@@ -1817,7 +2467,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1817
2467
|
successDescription: "The audit has been created"
|
|
1818
2468
|
}).errors({
|
|
1819
2469
|
NOT_FOUND: {},
|
|
1820
|
-
BAD_REQUEST: {},
|
|
1821
2470
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1822
2471
|
}).input(z.object({
|
|
1823
2472
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1825,7 +2474,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1825
2474
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1826
2475
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1827
2476
|
})).output(z.object({ id: z.string() }));
|
|
1828
|
-
const getBeaconContractV1 =
|
|
2477
|
+
const getBeaconContractV1 = base.route({
|
|
1829
2478
|
path: "/v1/beacon/audits/{auditId}",
|
|
1830
2479
|
method: "GET",
|
|
1831
2480
|
summary: "Get a beacon audit",
|
|
@@ -1840,9 +2489,73 @@ const getBeaconContractV1 = oc.route({
|
|
|
1840
2489
|
createdAt: z.coerce.date(),
|
|
1841
2490
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1842
2491
|
}));
|
|
2492
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2493
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2494
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2495
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2496
|
+
const createSubmissionContractV1 = base.route({
|
|
2497
|
+
path: "/v1/submissions",
|
|
2498
|
+
method: "POST",
|
|
2499
|
+
summary: "Create a submission package",
|
|
2500
|
+
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.",
|
|
2501
|
+
tags: ["submissions"],
|
|
2502
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2503
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2504
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2505
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2506
|
+
})).output(submissionSchema);
|
|
2507
|
+
const listSubmissionsContractV1 = base.route({
|
|
2508
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2509
|
+
method: "GET",
|
|
2510
|
+
summary: "List submission packages",
|
|
2511
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2512
|
+
tags: ["submissions"],
|
|
2513
|
+
successDescription: "The list of submission packages"
|
|
2514
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2515
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2516
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2517
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2518
|
+
})).output(z.array(submissionSchema));
|
|
2519
|
+
const getSubmissionContractV1 = base.route({
|
|
2520
|
+
path: "/v1/submissions/{submissionId}",
|
|
2521
|
+
method: "GET",
|
|
2522
|
+
summary: "Get a submission package",
|
|
2523
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2524
|
+
tags: ["submissions"],
|
|
2525
|
+
successDescription: "The submission package"
|
|
2526
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2527
|
+
const updateSubmissionContractV1 = base.route({
|
|
2528
|
+
path: "/v1/submissions/{submissionId}",
|
|
2529
|
+
method: "PUT",
|
|
2530
|
+
summary: "Update a submission package",
|
|
2531
|
+
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.",
|
|
2532
|
+
tags: ["submissions"],
|
|
2533
|
+
successDescription: "The updated submission package"
|
|
2534
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2535
|
+
submissionId: submissionIdSchema,
|
|
2536
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2537
|
+
formData: claudeSubmissionUpdateSchema
|
|
2538
|
+
}), z.object({
|
|
2539
|
+
submissionId: submissionIdSchema,
|
|
2540
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2541
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2542
|
+
})])).output(submissionSchema);
|
|
1843
2543
|
const contract = {
|
|
1844
|
-
teams: {
|
|
2544
|
+
teams: {
|
|
2545
|
+
list: { v1: listTeamsContractV1 },
|
|
2546
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2547
|
+
},
|
|
1845
2548
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2549
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2550
|
+
intentCategories: {
|
|
2551
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2552
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2553
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2554
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2555
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2556
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2557
|
+
},
|
|
2558
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1846
2559
|
deployments: {
|
|
1847
2560
|
list: { v1: listDeploymentsContractV1 },
|
|
1848
2561
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1852,6 +2565,7 @@ const contract = {
|
|
|
1852
2565
|
environments: {
|
|
1853
2566
|
create: { v1: createEnvironmentContractV1 },
|
|
1854
2567
|
get: { v1: getEnvironmentContractV1 },
|
|
2568
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1855
2569
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1856
2570
|
getLogs: { v1: getLogsContractV1 },
|
|
1857
2571
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1862,6 +2576,12 @@ const contract = {
|
|
|
1862
2576
|
update: { v1: updateEnvironmentVariableContractV1 },
|
|
1863
2577
|
delete: { v1: deleteEnvironmentVariableContractV1 }
|
|
1864
2578
|
},
|
|
2579
|
+
telemetryDestinations: {
|
|
2580
|
+
list: { v1: listTelemetryDestinationsContractV1 },
|
|
2581
|
+
create: { v1: createTelemetryDestinationContractV1 },
|
|
2582
|
+
update: { v1: updateTelemetryDestinationContractV1 },
|
|
2583
|
+
delete: { v1: deleteTelemetryDestinationContractV1 }
|
|
2584
|
+
},
|
|
1865
2585
|
projects: {
|
|
1866
2586
|
update: { v1: updateProjectContractV1 },
|
|
1867
2587
|
get: { v1: getProjectContractV1 },
|
|
@@ -1881,7 +2601,39 @@ const contract = {
|
|
|
1881
2601
|
beacon: {
|
|
1882
2602
|
create: { v1: createBeaconContractV1 },
|
|
1883
2603
|
get: { v1: getBeaconContractV1 }
|
|
2604
|
+
},
|
|
2605
|
+
submissions: {
|
|
2606
|
+
create: { v1: createSubmissionContractV1 },
|
|
2607
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2608
|
+
get: { v1: getSubmissionContractV1 },
|
|
2609
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2610
|
+
}
|
|
2611
|
+
};
|
|
2612
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2613
|
+
const contractForDocs = {
|
|
2614
|
+
...contract,
|
|
2615
|
+
deployments: deploymentsForDocs
|
|
2616
|
+
};
|
|
2617
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2618
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2619
|
+
info: {
|
|
2620
|
+
title: "Alpic API",
|
|
2621
|
+
version: "1.0.0"
|
|
2622
|
+
},
|
|
2623
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2624
|
+
security: [{ bearerAuth: [] }],
|
|
2625
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2626
|
+
type: "http",
|
|
2627
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2628
|
+
scheme: "bearer"
|
|
2629
|
+
} } },
|
|
2630
|
+
commonSchemas: {
|
|
2631
|
+
Submission: { schema: submissionSchema },
|
|
2632
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2633
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2634
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2635
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
1884
2636
|
}
|
|
1885
2637
|
};
|
|
1886
2638
|
//#endregion
|
|
1887
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2639
|
+
export { AI_PLATFORMS, AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, OPENAPI_DOC_OPTIONS, OTLP_PROTOCOLS, PLATFORM_LABELS, TELEMETRY_SIGNALS, buildSettingsSchema, chatgptSubmissionUpdateSchema, claudeSubmissionUpdateSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, otlpProtocolSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, telemetrySignalSchema, transportSchema, updateEnvironmentVariableSchema };
|