@alpic-ai/api 0.0.0-staging.g76ba2a0 → 0.0.0-staging.g76db2de
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 +6710 -96
- package/dist/index.mjs +1035 -231
- package/package.json +26 -10
package/dist/index.mjs
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
import * as z$1 from "zod/v4";
|
|
3
3
|
import { oc } from "@orpc/contract";
|
|
4
4
|
import ms from "ms";
|
|
5
|
-
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.32.1_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,11 +384,24 @@ 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
|
|
393
|
+
]);
|
|
394
|
+
const playgroundModelSchema = z.enum([
|
|
395
|
+
"global.anthropic.claude-haiku-5-5",
|
|
396
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
397
|
+
"global.anthropic.claude-sonnet-5-5",
|
|
398
|
+
"openai.gpt-5.4",
|
|
399
|
+
"openai.gpt-5.5",
|
|
400
|
+
"openai.gpt-6-luna",
|
|
401
|
+
"openai.gpt-6.1-sol"
|
|
343
402
|
]);
|
|
344
|
-
const allowedPlatformSchema = platformSchema;
|
|
345
403
|
const environmentDomainSchema = z.object({
|
|
346
|
-
|
|
404
|
+
name: z.string(),
|
|
347
405
|
status: z.enum([
|
|
348
406
|
"ongoing",
|
|
349
407
|
"deployed",
|
|
@@ -361,6 +419,7 @@ const environmentSchema$1 = z.object({
|
|
|
361
419
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
362
420
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
363
421
|
isPlaygroundEnabled: z.boolean(),
|
|
422
|
+
playgroundModel: playgroundModelSchema,
|
|
364
423
|
isIpWhitelistEnabled: z.boolean(),
|
|
365
424
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
366
425
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -373,14 +432,18 @@ z.object({
|
|
|
373
432
|
sessionReplayEnabled: z.boolean(),
|
|
374
433
|
collectRequestPayload: z.boolean(),
|
|
375
434
|
collectResponsePayload: z.boolean(),
|
|
376
|
-
collectErrorMessage: z.boolean()
|
|
435
|
+
collectErrorMessage: z.boolean(),
|
|
436
|
+
collectUserData: z.boolean(),
|
|
437
|
+
identityTraitKey: z.string().min(1).max(200).nullable(),
|
|
438
|
+
leadEventName: z.string().min(1).max(200).nullable()
|
|
377
439
|
});
|
|
378
|
-
z.object({
|
|
440
|
+
const feedbackSchema = z.object({
|
|
379
441
|
id: z.string(),
|
|
380
442
|
createdAt: z.coerce.date(),
|
|
381
443
|
environmentId: z.string(),
|
|
382
444
|
content: z.string(),
|
|
383
|
-
source: z.enum(["model", "user"])
|
|
445
|
+
source: z.enum(["model", "user"]),
|
|
446
|
+
clientName: z.string().nullable()
|
|
384
447
|
});
|
|
385
448
|
z.object({
|
|
386
449
|
content: z.string(),
|
|
@@ -396,7 +459,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
396
459
|
"pink",
|
|
397
460
|
"gray"
|
|
398
461
|
]);
|
|
399
|
-
intentCategoryColorSchema.options;
|
|
462
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
400
463
|
const intentCategorySchema = z.object({
|
|
401
464
|
id: z.string(),
|
|
402
465
|
createdAt: z.coerce.date(),
|
|
@@ -404,7 +467,7 @@ const intentCategorySchema = z.object({
|
|
|
404
467
|
name: z.string(),
|
|
405
468
|
color: intentCategoryColorSchema
|
|
406
469
|
});
|
|
407
|
-
z.object({
|
|
470
|
+
const intentCategorySummarySchema = z.object({
|
|
408
471
|
id: z.string(),
|
|
409
472
|
name: z.string(),
|
|
410
473
|
color: intentCategoryColorSchema,
|
|
@@ -416,6 +479,7 @@ z.object({
|
|
|
416
479
|
environmentId: z.string(),
|
|
417
480
|
toolName: z.string(),
|
|
418
481
|
message: z.string(),
|
|
482
|
+
clientName: z.string().nullable(),
|
|
419
483
|
categories: z.array(intentCategorySchema)
|
|
420
484
|
});
|
|
421
485
|
const signalCategorySchema = z.object({
|
|
@@ -474,12 +538,270 @@ z.object({
|
|
|
474
538
|
createdAt: z.coerce.date(),
|
|
475
539
|
updatedAt: z.coerce.date()
|
|
476
540
|
});
|
|
541
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
542
|
+
type: z.literal("mcp_request"),
|
|
543
|
+
method: z.string()
|
|
544
|
+
});
|
|
545
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
546
|
+
type: z.literal("mcp_error"),
|
|
547
|
+
method: z.string(),
|
|
548
|
+
error: z.string()
|
|
549
|
+
});
|
|
550
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
477
551
|
z.enum([
|
|
478
552
|
"INFO",
|
|
479
553
|
"WARNING",
|
|
480
554
|
"DEBUG",
|
|
481
555
|
"ERROR"
|
|
482
556
|
]);
|
|
557
|
+
const LOG_SEARCH_MAX_ESCAPED_LENGTH = 960;
|
|
558
|
+
function escapeLogSearchTerm(search) {
|
|
559
|
+
return [...search].flatMap((character) => [...new TextEncoder().encode(character)]).map((byte) => {
|
|
560
|
+
const character = String.fromCharCode(byte);
|
|
561
|
+
return /^[a-zA-Z0-9]$/.test(character) ? character : `\\x${byte.toString(16).toUpperCase().padStart(2, "0")}`;
|
|
562
|
+
}).join("");
|
|
563
|
+
}
|
|
564
|
+
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");
|
|
565
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
566
|
+
const MCP_CLIENT_GROUPS = [
|
|
567
|
+
{
|
|
568
|
+
id: "claude_code",
|
|
569
|
+
label: "Claude Code",
|
|
570
|
+
vendor: "anthropic",
|
|
571
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
572
|
+
},
|
|
573
|
+
{
|
|
574
|
+
id: "claude",
|
|
575
|
+
label: "Claude",
|
|
576
|
+
vendor: "anthropic",
|
|
577
|
+
rawNames: [
|
|
578
|
+
"Anthropic/ClaudeAI",
|
|
579
|
+
"claude-ai",
|
|
580
|
+
"claude",
|
|
581
|
+
"Claude",
|
|
582
|
+
"claude-desktop",
|
|
583
|
+
"claude-desktop-3p"
|
|
584
|
+
]
|
|
585
|
+
},
|
|
586
|
+
{
|
|
587
|
+
id: "claude_mobile",
|
|
588
|
+
label: "Claude mobile",
|
|
589
|
+
vendor: "anthropic",
|
|
590
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
591
|
+
},
|
|
592
|
+
{
|
|
593
|
+
id: "claude_cowork",
|
|
594
|
+
label: "Claude Cowork",
|
|
595
|
+
vendor: "anthropic",
|
|
596
|
+
rawNames: ["Anthropic/Cowork"]
|
|
597
|
+
},
|
|
598
|
+
{
|
|
599
|
+
id: "claude_sheet_add_in",
|
|
600
|
+
label: "Claude (Sheet Add-In)",
|
|
601
|
+
vendor: "anthropic",
|
|
602
|
+
rawNames: ["sheet-add-in"]
|
|
603
|
+
},
|
|
604
|
+
{
|
|
605
|
+
id: "claude_toolbox",
|
|
606
|
+
label: "Claude Toolbox",
|
|
607
|
+
vendor: "anthropic",
|
|
608
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
609
|
+
},
|
|
610
|
+
{
|
|
611
|
+
id: "anthropic_api",
|
|
612
|
+
label: "Anthropic API",
|
|
613
|
+
vendor: "anthropic",
|
|
614
|
+
rawNames: ["Anthropic/API"]
|
|
615
|
+
},
|
|
616
|
+
{
|
|
617
|
+
id: "anthropic_connector_refresh",
|
|
618
|
+
label: "Anthropic (connector refresh)",
|
|
619
|
+
vendor: "anthropic",
|
|
620
|
+
rawNames: ["Anthropic"]
|
|
621
|
+
},
|
|
622
|
+
{
|
|
623
|
+
id: "codex",
|
|
624
|
+
label: "Codex",
|
|
625
|
+
vendor: "openai",
|
|
626
|
+
rawNames: [
|
|
627
|
+
"codex-mcp-client",
|
|
628
|
+
"codex",
|
|
629
|
+
"Codex",
|
|
630
|
+
"codex-cli",
|
|
631
|
+
"openai-mcp (Codex)"
|
|
632
|
+
]
|
|
633
|
+
},
|
|
634
|
+
{
|
|
635
|
+
id: "chatgpt",
|
|
636
|
+
label: "ChatGPT",
|
|
637
|
+
vendor: "openai",
|
|
638
|
+
rawNames: ["openai-mcp", "openai-mcp (ChatGPT)"]
|
|
639
|
+
},
|
|
640
|
+
{
|
|
641
|
+
id: "openai_responses_api",
|
|
642
|
+
label: "OpenAI Responses API",
|
|
643
|
+
vendor: "openai",
|
|
644
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
645
|
+
},
|
|
646
|
+
{
|
|
647
|
+
id: "openai_agent_builder",
|
|
648
|
+
label: "OpenAI Agent Builder",
|
|
649
|
+
vendor: "openai",
|
|
650
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
651
|
+
},
|
|
652
|
+
{
|
|
653
|
+
id: "cursor",
|
|
654
|
+
label: "Cursor",
|
|
655
|
+
vendor: "cursor",
|
|
656
|
+
rawNames: [
|
|
657
|
+
"cursor-vscode",
|
|
658
|
+
"Cursor",
|
|
659
|
+
"cursor"
|
|
660
|
+
]
|
|
661
|
+
},
|
|
662
|
+
{
|
|
663
|
+
id: "cline",
|
|
664
|
+
label: "Cline",
|
|
665
|
+
vendor: "cline",
|
|
666
|
+
rawNames: [
|
|
667
|
+
"Cline",
|
|
668
|
+
"cline",
|
|
669
|
+
"@cline/core"
|
|
670
|
+
]
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
id: "github_copilot",
|
|
674
|
+
label: "GitHub Copilot",
|
|
675
|
+
vendor: "githubCopilot",
|
|
676
|
+
rawNames: [
|
|
677
|
+
"Copilot",
|
|
678
|
+
"github-copilot-developer",
|
|
679
|
+
"Copilot MCP Gateway",
|
|
680
|
+
"Xcode/copilot-xcode"
|
|
681
|
+
]
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
id: "gemini_cli",
|
|
685
|
+
label: "Gemini CLI",
|
|
686
|
+
vendor: "google",
|
|
687
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
688
|
+
},
|
|
689
|
+
{
|
|
690
|
+
id: "antigravity",
|
|
691
|
+
label: "Antigravity",
|
|
692
|
+
vendor: "google",
|
|
693
|
+
rawNames: ["antigravity-client"]
|
|
694
|
+
},
|
|
695
|
+
{
|
|
696
|
+
id: "gemini",
|
|
697
|
+
label: "Gemini",
|
|
698
|
+
vendor: "google",
|
|
699
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "windsurf",
|
|
703
|
+
label: "Windsurf",
|
|
704
|
+
vendor: "windsurf",
|
|
705
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
id: "mistral",
|
|
709
|
+
label: "Mistral / Le Chat",
|
|
710
|
+
vendor: "mistral",
|
|
711
|
+
rawNames: ["Mistral"],
|
|
712
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
713
|
+
},
|
|
714
|
+
{
|
|
715
|
+
id: "n8n",
|
|
716
|
+
label: "n8n",
|
|
717
|
+
vendor: "n8n",
|
|
718
|
+
rawNames: [
|
|
719
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
720
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
721
|
+
"n8n"
|
|
722
|
+
]
|
|
723
|
+
},
|
|
724
|
+
{
|
|
725
|
+
id: "alpic_playground",
|
|
726
|
+
label: "Alpic Playground",
|
|
727
|
+
vendor: "alpic",
|
|
728
|
+
rawNames: ["alpic-playground", "playground"]
|
|
729
|
+
},
|
|
730
|
+
{
|
|
731
|
+
id: "opencode",
|
|
732
|
+
label: "opencode",
|
|
733
|
+
vendor: "opencode",
|
|
734
|
+
rawNames: ["opencode"]
|
|
735
|
+
},
|
|
736
|
+
{
|
|
737
|
+
id: "zed",
|
|
738
|
+
label: "Zed",
|
|
739
|
+
vendor: "zed",
|
|
740
|
+
rawNames: ["Zed", "zed"]
|
|
741
|
+
},
|
|
742
|
+
{
|
|
743
|
+
id: "zapier",
|
|
744
|
+
label: "Zapier",
|
|
745
|
+
vendor: "zapier",
|
|
746
|
+
rawNames: ["Zapier", "zapier"]
|
|
747
|
+
},
|
|
748
|
+
{
|
|
749
|
+
id: "make",
|
|
750
|
+
label: "Make",
|
|
751
|
+
vendor: "make",
|
|
752
|
+
rawNames: ["Make", "make"]
|
|
753
|
+
},
|
|
754
|
+
{
|
|
755
|
+
id: "librechat",
|
|
756
|
+
label: "LibreChat",
|
|
757
|
+
vendor: "mcp",
|
|
758
|
+
rawNames: ["LibreChat", "librechat"]
|
|
759
|
+
},
|
|
760
|
+
{
|
|
761
|
+
id: "jan",
|
|
762
|
+
label: "Jan",
|
|
763
|
+
vendor: "mcp",
|
|
764
|
+
rawNames: ["Jan", "jan"]
|
|
765
|
+
},
|
|
766
|
+
{
|
|
767
|
+
id: "goose",
|
|
768
|
+
label: "goose",
|
|
769
|
+
vendor: "mcp",
|
|
770
|
+
rawNames: ["goose", "Goose"]
|
|
771
|
+
},
|
|
772
|
+
{
|
|
773
|
+
id: "mcphost",
|
|
774
|
+
label: "mcphost",
|
|
775
|
+
vendor: "mcp",
|
|
776
|
+
rawNames: ["mcphost"]
|
|
777
|
+
},
|
|
778
|
+
{
|
|
779
|
+
id: "mcporter",
|
|
780
|
+
label: "mcporter",
|
|
781
|
+
vendor: "mcp",
|
|
782
|
+
rawNames: ["mcporter"]
|
|
783
|
+
},
|
|
784
|
+
{
|
|
785
|
+
id: "rmcp",
|
|
786
|
+
label: "rmcp",
|
|
787
|
+
vendor: "mcp",
|
|
788
|
+
rawNames: ["rmcp"]
|
|
789
|
+
},
|
|
790
|
+
{
|
|
791
|
+
id: "unnamed_client",
|
|
792
|
+
label: "Unnamed client",
|
|
793
|
+
vendor: "mcp",
|
|
794
|
+
rawNames: [
|
|
795
|
+
"mcp",
|
|
796
|
+
"unknown",
|
|
797
|
+
""
|
|
798
|
+
]
|
|
799
|
+
}
|
|
800
|
+
];
|
|
801
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
802
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
803
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
804
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
483
805
|
const runtimeSchema = z.enum([
|
|
484
806
|
"python3.13",
|
|
485
807
|
"python3.14",
|
|
@@ -508,15 +830,27 @@ z.object({
|
|
|
508
830
|
environments: z.array(environmentWithDomainsSchema),
|
|
509
831
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
510
832
|
});
|
|
833
|
+
const domainFailureReasonSchema = z.enum([
|
|
834
|
+
"caa",
|
|
835
|
+
"dns",
|
|
836
|
+
"invalid_domain",
|
|
837
|
+
"other"
|
|
838
|
+
]);
|
|
839
|
+
const projectDomainMappingSchema = z.object({
|
|
840
|
+
pathPrefix: z.string(),
|
|
841
|
+
environment: environmentSchema$1
|
|
842
|
+
});
|
|
511
843
|
z.object({
|
|
512
|
-
|
|
844
|
+
name: z.string(),
|
|
513
845
|
createdAt: z.coerce.date(),
|
|
514
846
|
status: z.enum([
|
|
515
847
|
"ongoing",
|
|
516
848
|
"deployed",
|
|
517
849
|
"failed"
|
|
518
850
|
]),
|
|
519
|
-
|
|
851
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
852
|
+
environment: environmentSchema$1,
|
|
853
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
520
854
|
});
|
|
521
855
|
const serverFieldsSchema$1 = z.object({
|
|
522
856
|
$schema: z.string(),
|
|
@@ -545,15 +879,7 @@ z.object({
|
|
|
545
879
|
serverFields: serverFieldsSchema$1,
|
|
546
880
|
source: z.enum(["registry", "defaults"])
|
|
547
881
|
});
|
|
548
|
-
/**
|
|
549
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
550
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
551
|
-
*
|
|
552
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
553
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
554
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
555
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
556
|
-
*/
|
|
882
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
557
883
|
const clampStringField = (field) => {
|
|
558
884
|
const max = field.maxLength;
|
|
559
885
|
if (max === null) return field;
|
|
@@ -561,6 +887,10 @@ const clampStringField = (field) => {
|
|
|
561
887
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
562
888
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
563
889
|
};
|
|
890
|
+
const unboundedArrayField = (field) => {
|
|
891
|
+
const unbounded = z.array(field.element);
|
|
892
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
893
|
+
};
|
|
564
894
|
const toolDefinitionSchema = z.object({
|
|
565
895
|
name: z.string(),
|
|
566
896
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -573,15 +903,27 @@ const toolDefinitionSchema = z.object({
|
|
|
573
903
|
}).optional()
|
|
574
904
|
});
|
|
575
905
|
const positiveTestCaseSchema = z.object({
|
|
576
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
577
|
-
userPrompt: z.string().describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
906
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
907
|
+
userPrompt: z.string().min(1).describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
578
908
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
579
909
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
580
|
-
}).
|
|
910
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
911
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
912
|
+
scenario: z.string().optional(),
|
|
913
|
+
userPrompt: z.string().optional()
|
|
914
|
+
});
|
|
915
|
+
const blankPositiveTestCase = () => ({
|
|
916
|
+
scenario: "",
|
|
917
|
+
userPrompt: "",
|
|
918
|
+
toolTriggered: "",
|
|
919
|
+
expectedOutput: ""
|
|
920
|
+
});
|
|
921
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
581
922
|
const screenshotEntrySchema = z.object({
|
|
582
923
|
prompt: z.string(),
|
|
583
|
-
url: z.url()
|
|
924
|
+
url: z.url()
|
|
584
925
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
926
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
585
927
|
/** Accepts either a valid email or URL. */
|
|
586
928
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
587
929
|
/** A URL field whose error spells out that the scheme is required. */
|
|
@@ -889,20 +1231,25 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
889
1231
|
"zh-TW"
|
|
890
1232
|
]);
|
|
891
1233
|
const negativeTestCaseSchema = z.object({
|
|
892
|
-
scenario: z.string(),
|
|
893
|
-
userPrompt: z.string()
|
|
894
|
-
}).
|
|
1234
|
+
scenario: z.string().min(1),
|
|
1235
|
+
userPrompt: z.string().min(1)
|
|
1236
|
+
}).describe("Each case: Scenario + User prompt (the plugin should NOT trigger).");
|
|
1237
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1238
|
+
scenario: z.string().optional(),
|
|
1239
|
+
userPrompt: z.string().optional()
|
|
1240
|
+
});
|
|
1241
|
+
const blankNegativeTestCase = () => ({
|
|
1242
|
+
scenario: "",
|
|
1243
|
+
userPrompt: ""
|
|
1244
|
+
});
|
|
1245
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
895
1246
|
const chatgptToolJustificationSchema = z.object({
|
|
896
1247
|
toolName: z.string(),
|
|
897
1248
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
898
1249
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
899
1250
|
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
900
1251
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
901
|
-
/**
|
|
902
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
903
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
904
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
905
|
-
*/
|
|
1252
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
906
1253
|
const chatgptTaglineSchema = z.string().max(30);
|
|
907
1254
|
const chatgptDescriptionSchema = z.string();
|
|
908
1255
|
const chatgptTranslationSchema = z.object({
|
|
@@ -911,50 +1258,71 @@ const chatgptTranslationSchema = z.object({
|
|
|
911
1258
|
description: chatgptDescriptionSchema
|
|
912
1259
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
913
1260
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
914
|
-
/**
|
|
915
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
916
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
917
|
-
*/
|
|
1261
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
918
1262
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
919
1263
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
920
1264
|
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."),
|
|
921
|
-
appName: z.string().describe("The name users will see in ChatGPT and in the
|
|
1265
|
+
appName: z.string().describe("The name users will see in ChatGPT and in the Plugin Directory."),
|
|
922
1266
|
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
923
|
-
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the
|
|
1267
|
+
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)."),
|
|
924
1268
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
925
|
-
developerName: z.string().describe("Developer name shown publicly on the
|
|
1269
|
+
developerName: z.string().describe("Developer name shown publicly on the plugin's directory page."),
|
|
926
1270
|
companyUrl: urlField.describe("Your company's main website URL."),
|
|
927
1271
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
928
1272
|
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
929
|
-
termsOfServiceUrl: urlField.describe("URL to the
|
|
930
|
-
demoRecordingUrl: urlField.describe("URL to a video demonstrating the
|
|
931
|
-
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My
|
|
1273
|
+
termsOfServiceUrl: urlField.describe("URL to the plugin's terms of service."),
|
|
1274
|
+
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."),
|
|
1275
|
+
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."),
|
|
932
1276
|
serverUrl: urlField.describe("URL of the MCP server."),
|
|
933
1277
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
934
1278
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
935
1279
|
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
1280
|
+
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."),
|
|
1281
|
+
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."),
|
|
1282
|
+
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."),
|
|
1283
|
+
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."),
|
|
939
1284
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
940
1285
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
941
|
-
releaseNotes: z.string().describe("Publicly displayed on the
|
|
1286
|
+
releaseNotes: z.string().describe("Publicly displayed on the plugin details page.")
|
|
1287
|
+
});
|
|
1288
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1289
|
+
tagline: z.string().optional(),
|
|
1290
|
+
companyUrl: z.string().optional(),
|
|
1291
|
+
supportChannel: z.string().optional(),
|
|
1292
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1293
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1294
|
+
demoRecordingUrl: z.string().optional(),
|
|
1295
|
+
serverUrl: z.string().optional(),
|
|
1296
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1297
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1298
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1299
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
942
1300
|
});
|
|
943
|
-
|
|
1301
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1302
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
944
1303
|
appName: true,
|
|
945
1304
|
developerName: true,
|
|
946
1305
|
serverUrl: true,
|
|
947
1306
|
tools: true,
|
|
1307
|
+
skills: true,
|
|
948
1308
|
authentication: true
|
|
949
1309
|
});
|
|
950
|
-
|
|
1310
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1311
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
951
1312
|
tagline: true,
|
|
952
1313
|
description: true,
|
|
953
1314
|
category: true,
|
|
954
1315
|
testCases: true,
|
|
955
1316
|
negativeTestCases: true,
|
|
956
1317
|
toolJustifications: true
|
|
957
|
-
}).extend({
|
|
1318
|
+
}).extend({
|
|
1319
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1320
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1321
|
+
}).extend({
|
|
1322
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1323
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1324
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1325
|
+
});
|
|
958
1326
|
const claudeCategorySchema = z.enum([
|
|
959
1327
|
"Productivity",
|
|
960
1328
|
"Communication",
|
|
@@ -1000,11 +1368,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1000
1368
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1001
1369
|
"Public documentation for this connector will be live by the publish date."
|
|
1002
1370
|
]);
|
|
1003
|
-
/**
|
|
1004
|
-
* Field order mirrors the claude.ai directory submission wizard
|
|
1005
|
-
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1006
|
-
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1007
|
-
*/
|
|
1371
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
1008
1372
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1009
1373
|
serverUrl: z.url().describe(`The full https:// URL where your MCP server is hosted and reachable. In the claude.ai wizard this is read live
|
|
1010
1374
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1018,8 +1382,8 @@ phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects i
|
|
|
1018
1382
|
description: z.string().max(2e3).describe(`A description of what your connector does and its key features, shown on the connector's detail page in
|
|
1019
1383
|
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1020
1384
|
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1021
|
-
iconUrl: z.url().optional().describe(`Optional custom icon
|
|
1022
|
-
|
|
1385
|
+
iconUrl: z.url().optional().describe(`Optional custom icon for the directory listing — a square SVG. By default the favicon from your MCP URL is used
|
|
1386
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1023
1387
|
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1024
1388
|
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1025
1389
|
by your publish date.`),
|
|
@@ -1027,6 +1391,8 @@ by your publish date.`),
|
|
|
1027
1391
|
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1028
1392
|
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1029
1393
|
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1394
|
+
screenshots: z.array(screenshotEntrySchema).optional().describe(`Carousel images shown on your connector's directory page (PNG). Each is paired with the user prompt that produced
|
|
1395
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1030
1396
|
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1031
1397
|
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1032
1398
|
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
@@ -1064,7 +1430,23 @@ fully populated account.`),
|
|
|
1064
1430
|
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1065
1431
|
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1066
1432
|
});
|
|
1067
|
-
claudeSubmissionFormDataSchema.
|
|
1433
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1434
|
+
serverUrl: z.string().optional(),
|
|
1435
|
+
name: z.string().optional(),
|
|
1436
|
+
slug: z.string().optional(),
|
|
1437
|
+
oneLiner: z.string().optional(),
|
|
1438
|
+
description: z.string().optional(),
|
|
1439
|
+
iconUrl: z.string().optional(),
|
|
1440
|
+
documentation: z.string().optional(),
|
|
1441
|
+
support: z.string().optional(),
|
|
1442
|
+
privacyPolicy: z.string().optional(),
|
|
1443
|
+
companyWebsite: z.string().optional(),
|
|
1444
|
+
primaryContactEmail: z.string().optional(),
|
|
1445
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1446
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1447
|
+
});
|
|
1448
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1449
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1068
1450
|
serverUrl: true,
|
|
1069
1451
|
name: true,
|
|
1070
1452
|
slug: true,
|
|
@@ -1079,39 +1461,93 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1079
1461
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1080
1462
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1081
1463
|
});
|
|
1082
|
-
/**
|
|
1083
|
-
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1084
|
-
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1085
|
-
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1086
|
-
* colocated with the Claude contract.
|
|
1087
|
-
*/
|
|
1464
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1088
1465
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1089
1466
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1090
1467
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1091
1468
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1092
1469
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1093
1470
|
});
|
|
1094
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1471
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1095
1472
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1096
1473
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1097
1474
|
});
|
|
1475
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1476
|
+
const byField = {};
|
|
1477
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1478
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1479
|
+
return byField;
|
|
1480
|
+
}
|
|
1481
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1482
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1483
|
+
"pass",
|
|
1484
|
+
"fail",
|
|
1485
|
+
"unverified"
|
|
1486
|
+
]);
|
|
1487
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1488
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1489
|
+
claudeai: ["privacyPolicy"]
|
|
1490
|
+
};
|
|
1491
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1492
|
+
const policyDisclosureSchema = z.enum([
|
|
1493
|
+
"dataCategories",
|
|
1494
|
+
"purposesOfUse",
|
|
1495
|
+
"recipients",
|
|
1496
|
+
"retention"
|
|
1497
|
+
]);
|
|
1498
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1499
|
+
field: verifiableUrlFieldSchema,
|
|
1500
|
+
url: z.string(),
|
|
1501
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1502
|
+
reason: z.string(),
|
|
1503
|
+
concerns: z.array(z.string()).optional(),
|
|
1504
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1505
|
+
});
|
|
1506
|
+
const urlVerificationSchema = z.object({
|
|
1507
|
+
verifiedAt: z.coerce.date(),
|
|
1508
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1509
|
+
});
|
|
1510
|
+
const pageKindSchema = z.enum([
|
|
1511
|
+
"expectedDocument",
|
|
1512
|
+
"errorPage",
|
|
1513
|
+
"loginWall",
|
|
1514
|
+
"parkedDomain",
|
|
1515
|
+
"comingSoon",
|
|
1516
|
+
"marketingPage",
|
|
1517
|
+
"unrelatedDocument"
|
|
1518
|
+
]);
|
|
1519
|
+
z.object({
|
|
1520
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1521
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1522
|
+
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.")
|
|
1523
|
+
});
|
|
1098
1524
|
const submissionMetaFieldsSchema = z.object({
|
|
1099
1525
|
id: z.string(),
|
|
1100
1526
|
environmentId: z.string(),
|
|
1101
1527
|
auditId: z.string().nullable(),
|
|
1528
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1102
1529
|
createdAt: z.coerce.date(),
|
|
1103
1530
|
updatedAt: z.coerce.date()
|
|
1104
1531
|
});
|
|
1105
1532
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1106
1533
|
platform: z.literal("claudeai"),
|
|
1107
|
-
formData:
|
|
1534
|
+
formData: claudeSubmissionDraftSchema,
|
|
1535
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1108
1536
|
});
|
|
1109
1537
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1110
1538
|
platform: z.literal("chatgpt"),
|
|
1111
|
-
formData:
|
|
1539
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1540
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1112
1541
|
});
|
|
1113
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1114
|
-
z.union([
|
|
1542
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1543
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1544
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1545
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1546
|
+
z.literal([
|
|
1547
|
+
100,
|
|
1548
|
+
75,
|
|
1549
|
+
50
|
|
1550
|
+
]);
|
|
1115
1551
|
const subscriptionPlanSchema = z.enum([
|
|
1116
1552
|
"pro",
|
|
1117
1553
|
"business",
|
|
@@ -1123,17 +1559,78 @@ const customerCreditsSchema = z.object({
|
|
|
1123
1559
|
expiresAt: z.number().nullable(),
|
|
1124
1560
|
currency: z.string()
|
|
1125
1561
|
});
|
|
1126
|
-
const customerUsageSchema = z.object({
|
|
1127
|
-
amountInCents: z.number(),
|
|
1128
|
-
currency: z.string(),
|
|
1129
|
-
periodEnd: z.number()
|
|
1130
|
-
});
|
|
1131
1562
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1132
1563
|
z.object({
|
|
1133
1564
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1134
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1135
1565
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1136
1566
|
});
|
|
1567
|
+
const metricsQueueEventSchema = z.object({
|
|
1568
|
+
ts: z.number().int(),
|
|
1569
|
+
method: z.string(),
|
|
1570
|
+
tool: z.string().nullable(),
|
|
1571
|
+
client: z.string(),
|
|
1572
|
+
sessionId: z.string().nullable(),
|
|
1573
|
+
conversationId: z.string().nullable().optional(),
|
|
1574
|
+
durationMs: z.number().int(),
|
|
1575
|
+
outputTokens: z.number().int().nullable(),
|
|
1576
|
+
errorType: z.enum([
|
|
1577
|
+
"mcp_error",
|
|
1578
|
+
"tool_error",
|
|
1579
|
+
"timeout"
|
|
1580
|
+
]).nullable(),
|
|
1581
|
+
errorCode: z.number().int().nullable()
|
|
1582
|
+
});
|
|
1583
|
+
z.object({
|
|
1584
|
+
v: z.literal(1),
|
|
1585
|
+
envId: z.string(),
|
|
1586
|
+
events: z.array(metricsQueueEventSchema)
|
|
1587
|
+
});
|
|
1588
|
+
z.object({ v: z.number() });
|
|
1589
|
+
const TELEMETRY_SIGNALS = [
|
|
1590
|
+
"logs",
|
|
1591
|
+
"metrics",
|
|
1592
|
+
"traces"
|
|
1593
|
+
];
|
|
1594
|
+
const telemetrySignalSchema = z.enum(TELEMETRY_SIGNALS);
|
|
1595
|
+
const OTLP_PROTOCOLS = ["http/protobuf", "http/json"];
|
|
1596
|
+
const otlpProtocolSchema = z.enum(OTLP_PROTOCOLS);
|
|
1597
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1598
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1599
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1600
|
+
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");
|
|
1601
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1602
|
+
id: z.string(),
|
|
1603
|
+
name: otlpHeaderNameSchema,
|
|
1604
|
+
value: otlpHeaderValueSchema,
|
|
1605
|
+
isSecret: z.boolean()
|
|
1606
|
+
});
|
|
1607
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1608
|
+
"credentials",
|
|
1609
|
+
"wrong-path",
|
|
1610
|
+
"wrong-protocol",
|
|
1611
|
+
"invalid-payload",
|
|
1612
|
+
"partial-rejection",
|
|
1613
|
+
"blocked-target",
|
|
1614
|
+
"timeout",
|
|
1615
|
+
"unreachable",
|
|
1616
|
+
"receiver-error",
|
|
1617
|
+
"unexpected-status"
|
|
1618
|
+
]);
|
|
1619
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1620
|
+
z.object({
|
|
1621
|
+
id: z.string(),
|
|
1622
|
+
signal: telemetrySignalSchema,
|
|
1623
|
+
endpoint: otlpEndpointSchema,
|
|
1624
|
+
protocol: otlpProtocolSchema,
|
|
1625
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1626
|
+
status: telemetryDestinationStatusSchema,
|
|
1627
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable(),
|
|
1628
|
+
isScopedToIntentionalRequestsOnly: z.boolean()
|
|
1629
|
+
});
|
|
1630
|
+
const hasDuplicateHeaderNames = (headers) => {
|
|
1631
|
+
const names = headers.map(({ name }) => name.trim().toLowerCase());
|
|
1632
|
+
return new Set(names).size !== names.length;
|
|
1633
|
+
};
|
|
1137
1634
|
//#endregion
|
|
1138
1635
|
//#region src/auth-scope.ts
|
|
1139
1636
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1176,7 +1673,10 @@ const RESERVED_KEYS = [
|
|
|
1176
1673
|
"BUILD_ARG_START_COMMAND",
|
|
1177
1674
|
"ALPIC_HOST",
|
|
1178
1675
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1179
|
-
"ALPIC_INTENT_META_KEY"
|
|
1676
|
+
"ALPIC_INTENT_META_KEY",
|
|
1677
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1678
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1679
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1180
1680
|
];
|
|
1181
1681
|
const environmentVariableSchema = z.object({
|
|
1182
1682
|
key: z.string().min(2, "Key must be at least 2 characters").regex(/^[a-zA-Z]([a-zA-Z0-9_])+$/, "Key must start with a letter and contain only letters, numbers, and underscores").refine((key) => !RESERVED_KEYS.includes(key), "This key is reserved and cannot be used as an environment variable key"),
|
|
@@ -1229,6 +1729,14 @@ const serverFieldsSchema = z.object({
|
|
|
1229
1729
|
});
|
|
1230
1730
|
//#endregion
|
|
1231
1731
|
//#region src/api.contract.ts
|
|
1732
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1733
|
+
try {
|
|
1734
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1735
|
+
return true;
|
|
1736
|
+
} catch {
|
|
1737
|
+
return false;
|
|
1738
|
+
}
|
|
1739
|
+
};
|
|
1232
1740
|
const deploymentStatusSchema = z.enum([
|
|
1233
1741
|
"ongoing",
|
|
1234
1742
|
"deployed",
|
|
@@ -1257,21 +1765,20 @@ const deploymentSchema = z.object({
|
|
|
1257
1765
|
isCurrent: z.boolean(),
|
|
1258
1766
|
deploymentPageUrl: z.url().nullable()
|
|
1259
1767
|
});
|
|
1260
|
-
const
|
|
1768
|
+
const isValidTimeInput = (value) => {
|
|
1261
1769
|
if (ms(value) !== void 0) return true;
|
|
1262
1770
|
return !Number.isNaN(new Date(value).getTime());
|
|
1263
1771
|
};
|
|
1264
|
-
const
|
|
1772
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1773
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1774
|
+
const createEnvironmentContractV1 = base.route({
|
|
1265
1775
|
path: "/v1/environments",
|
|
1266
1776
|
method: "POST",
|
|
1267
1777
|
summary: "Create an environment",
|
|
1268
1778
|
description: "Create an environment for a project",
|
|
1269
1779
|
tags: ["environments"],
|
|
1270
1780
|
successDescription: "The environment has been created successfully"
|
|
1271
|
-
}).errors({
|
|
1272
|
-
NOT_FOUND: {},
|
|
1273
|
-
BAD_REQUEST: {}
|
|
1274
|
-
}).input(z.object({
|
|
1781
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1275
1782
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1276
1783
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1277
1784
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1284,7 +1791,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1284
1791
|
createdAt: z.coerce.date(),
|
|
1285
1792
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1286
1793
|
}));
|
|
1287
|
-
const getEnvironmentContractV1 =
|
|
1794
|
+
const getEnvironmentContractV1 = base.route({
|
|
1288
1795
|
path: "/v1/environments/{environmentId}",
|
|
1289
1796
|
method: "GET",
|
|
1290
1797
|
summary: "Get an environment",
|
|
@@ -1300,6 +1807,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1300
1807
|
createdAt: z.coerce.date(),
|
|
1301
1808
|
projectId: z.string()
|
|
1302
1809
|
}));
|
|
1810
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1811
|
+
path: "/v1/environments/{environmentId}",
|
|
1812
|
+
method: "DELETE",
|
|
1813
|
+
summary: "Delete an environment",
|
|
1814
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1815
|
+
tags: ["environments"],
|
|
1816
|
+
successDescription: "The environment has been deleted successfully"
|
|
1817
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1303
1818
|
const domainSchema = z.object({
|
|
1304
1819
|
domain: z.string(),
|
|
1305
1820
|
status: z.enum([
|
|
@@ -1341,7 +1856,7 @@ const projectOutputSchema = z.object({
|
|
|
1341
1856
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1342
1857
|
environments: z.array(environmentSchema)
|
|
1343
1858
|
});
|
|
1344
|
-
const getProjectContractV1 =
|
|
1859
|
+
const getProjectContractV1 = base.route({
|
|
1345
1860
|
path: "/v1/projects/{projectId}",
|
|
1346
1861
|
method: "GET",
|
|
1347
1862
|
summary: "Get a project",
|
|
@@ -1349,18 +1864,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1349
1864
|
tags: ["projects"],
|
|
1350
1865
|
successDescription: "The project details"
|
|
1351
1866
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1352
|
-
const listProjectsContractV1 =
|
|
1867
|
+
const listProjectsContractV1 = base.route({
|
|
1353
1868
|
path: "/v1/projects",
|
|
1354
1869
|
method: "GET",
|
|
1355
1870
|
summary: "List projects",
|
|
1356
1871
|
description: "List all projects for a team",
|
|
1357
1872
|
tags: ["projects"],
|
|
1358
1873
|
successDescription: "The list of projects"
|
|
1359
|
-
}).errors({
|
|
1360
|
-
|
|
1361
|
-
BAD_REQUEST: {}
|
|
1362
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1363
|
-
const createProjectContractV1 = oc.route({
|
|
1874
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1875
|
+
const createProjectContractV1 = base.route({
|
|
1364
1876
|
path: "/v1/projects",
|
|
1365
1877
|
method: "POST",
|
|
1366
1878
|
summary: "Create a project",
|
|
@@ -1369,7 +1881,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1369
1881
|
successDescription: "The project has been created successfully"
|
|
1370
1882
|
}).errors({
|
|
1371
1883
|
NOT_FOUND: {},
|
|
1372
|
-
BAD_REQUEST: {},
|
|
1373
1884
|
FORBIDDEN: {}
|
|
1374
1885
|
}).input(z.object({
|
|
1375
1886
|
teamId: z.string().optional(),
|
|
@@ -1410,7 +1921,101 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1410
1921
|
isSecret: z.boolean(),
|
|
1411
1922
|
createdAt: z.coerce.date()
|
|
1412
1923
|
});
|
|
1413
|
-
const
|
|
1924
|
+
const telemetryDestinationHeaderOutputSchema = z.discriminatedUnion("isSecret", [z.object({
|
|
1925
|
+
id: z.string(),
|
|
1926
|
+
name: otlpHeaderNameSchema,
|
|
1927
|
+
value: z.null(),
|
|
1928
|
+
isSecret: z.literal(true)
|
|
1929
|
+
}), z.object({
|
|
1930
|
+
id: z.string(),
|
|
1931
|
+
name: otlpHeaderNameSchema,
|
|
1932
|
+
value: otlpHeaderValueSchema,
|
|
1933
|
+
isSecret: z.literal(false)
|
|
1934
|
+
})]);
|
|
1935
|
+
const telemetryDestinationOutputSchema = z.object({
|
|
1936
|
+
id: z.string(),
|
|
1937
|
+
signal: telemetrySignalSchema,
|
|
1938
|
+
endpoint: otlpEndpointSchema,
|
|
1939
|
+
protocol: otlpProtocolSchema,
|
|
1940
|
+
headers: z.array(telemetryDestinationHeaderOutputSchema),
|
|
1941
|
+
status: telemetryDestinationStatusSchema,
|
|
1942
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable(),
|
|
1943
|
+
isScopedToIntentionalRequestsOnly: z.boolean()
|
|
1944
|
+
});
|
|
1945
|
+
const createTelemetryDestinationHeaderInputSchema = z.object({
|
|
1946
|
+
name: otlpHeaderNameSchema,
|
|
1947
|
+
value: otlpHeaderValueSchema.min(1, "Enter a header value"),
|
|
1948
|
+
isSecret: z.boolean()
|
|
1949
|
+
});
|
|
1950
|
+
const updateTelemetryDestinationHeaderInputSchema = z.object({
|
|
1951
|
+
id: z.string().optional(),
|
|
1952
|
+
name: otlpHeaderNameSchema,
|
|
1953
|
+
value: otlpHeaderValueSchema.optional(),
|
|
1954
|
+
isSecret: z.boolean()
|
|
1955
|
+
});
|
|
1956
|
+
const uniqueTelemetryHeaders = (headers) => !hasDuplicateHeaderNames(headers);
|
|
1957
|
+
const listTelemetryDestinationsContractV1 = base.route({
|
|
1958
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations",
|
|
1959
|
+
method: "GET",
|
|
1960
|
+
summary: "List telemetry destinations",
|
|
1961
|
+
description: "List the OTLP destinations configured for an environment. Secret header values are never returned.",
|
|
1962
|
+
tags: ["telemetry"],
|
|
1963
|
+
successDescription: "The list of telemetry destinations"
|
|
1964
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(telemetryDestinationOutputSchema));
|
|
1965
|
+
const createTelemetryDestinationContractV1 = base.route({
|
|
1966
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations",
|
|
1967
|
+
method: "POST",
|
|
1968
|
+
summary: "Create a telemetry destination",
|
|
1969
|
+
description: "Verify and save an OTLP destination for logs, metrics, or traces.",
|
|
1970
|
+
tags: ["telemetry"],
|
|
1971
|
+
successDescription: "The telemetry destination has been created"
|
|
1972
|
+
}).errors({
|
|
1973
|
+
NOT_FOUND: {},
|
|
1974
|
+
FORBIDDEN: {},
|
|
1975
|
+
OTLP_DESTINATION_UNVERIFIED: { status: 400 },
|
|
1976
|
+
INTERNAL_SERVER_ERROR: {}
|
|
1977
|
+
}).input(z.object({
|
|
1978
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1979
|
+
signal: telemetrySignalSchema,
|
|
1980
|
+
endpoint: otlpEndpointSchema,
|
|
1981
|
+
protocol: otlpProtocolSchema.default("http/protobuf"),
|
|
1982
|
+
isScopedToIntentionalRequestsOnly: z.boolean().default(false),
|
|
1983
|
+
headers: z.array(createTelemetryDestinationHeaderInputSchema).default([]).refine(uniqueTelemetryHeaders, "Header names must be unique")
|
|
1984
|
+
})).output(telemetryDestinationOutputSchema);
|
|
1985
|
+
const updateTelemetryDestinationContractV1 = base.route({
|
|
1986
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations/{destinationId}",
|
|
1987
|
+
method: "PATCH",
|
|
1988
|
+
summary: "Update a telemetry destination",
|
|
1989
|
+
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.",
|
|
1990
|
+
tags: ["telemetry"],
|
|
1991
|
+
successDescription: "The telemetry destination has been updated"
|
|
1992
|
+
}).errors({
|
|
1993
|
+
NOT_FOUND: {},
|
|
1994
|
+
FORBIDDEN: {},
|
|
1995
|
+
OTLP_DESTINATION_UNVERIFIED: { status: 400 }
|
|
1996
|
+
}).input(z.object({
|
|
1997
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1998
|
+
destinationId: z.string().describe("The ID of the telemetry destination"),
|
|
1999
|
+
endpoint: otlpEndpointSchema.optional(),
|
|
2000
|
+
protocol: otlpProtocolSchema.optional(),
|
|
2001
|
+
isScopedToIntentionalRequestsOnly: z.boolean().optional(),
|
|
2002
|
+
headers: z.array(updateTelemetryDestinationHeaderInputSchema).refine(uniqueTelemetryHeaders, "Header names must be unique").optional()
|
|
2003
|
+
})).output(telemetryDestinationOutputSchema);
|
|
2004
|
+
const deleteTelemetryDestinationContractV1 = base.route({
|
|
2005
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations/{destinationId}",
|
|
2006
|
+
method: "DELETE",
|
|
2007
|
+
summary: "Delete a telemetry destination",
|
|
2008
|
+
description: "Delete an OTLP destination from an environment.",
|
|
2009
|
+
tags: ["telemetry"],
|
|
2010
|
+
successDescription: "The telemetry destination has been deleted"
|
|
2011
|
+
}).errors({
|
|
2012
|
+
NOT_FOUND: {},
|
|
2013
|
+
INTERNAL_SERVER_ERROR: {}
|
|
2014
|
+
}).input(z.object({
|
|
2015
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2016
|
+
destinationId: z.string().describe("The ID of the telemetry destination")
|
|
2017
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2018
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1414
2019
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1415
2020
|
method: "GET",
|
|
1416
2021
|
summary: "List environment variables",
|
|
@@ -1418,48 +2023,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1418
2023
|
tags: ["environments"],
|
|
1419
2024
|
successDescription: "The list of environment variables"
|
|
1420
2025
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1421
|
-
const createEnvironmentVariablesContractV1 =
|
|
2026
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1422
2027
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1423
2028
|
method: "POST",
|
|
1424
2029
|
summary: "Add environment variables",
|
|
1425
2030
|
description: "Add one or more environment variables to an environment",
|
|
1426
2031
|
tags: ["environments"],
|
|
1427
2032
|
successDescription: "The environment variables have been added successfully"
|
|
1428
|
-
}).errors({
|
|
1429
|
-
NOT_FOUND: {},
|
|
1430
|
-
BAD_REQUEST: {}
|
|
1431
|
-
}).input(z.object({
|
|
2033
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1432
2034
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1433
2035
|
environmentVariables: environmentVariablesSchema
|
|
1434
2036
|
})).output(z.object({ success: z.literal(true) }));
|
|
1435
|
-
const updateEnvironmentVariableContractV1 =
|
|
2037
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1436
2038
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1437
2039
|
method: "PATCH",
|
|
1438
2040
|
summary: "Update an environment variable",
|
|
1439
2041
|
description: "Update an environment variable by ID",
|
|
1440
2042
|
tags: ["environments"],
|
|
1441
2043
|
successDescription: "The environment variable has been updated successfully"
|
|
1442
|
-
}).errors({
|
|
1443
|
-
NOT_FOUND: {},
|
|
1444
|
-
BAD_REQUEST: {}
|
|
1445
|
-
}).input(z.object({
|
|
2044
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1446
2045
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1447
2046
|
key: environmentVariableSchema.shape.key,
|
|
1448
2047
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1449
2048
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1450
2049
|
})).output(z.object({ success: z.literal(true) }));
|
|
1451
|
-
const deleteEnvironmentVariableContractV1 =
|
|
2050
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1452
2051
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1453
2052
|
method: "DELETE",
|
|
1454
2053
|
summary: "Delete an environment variable",
|
|
1455
2054
|
description: "Delete an environment variable by ID",
|
|
1456
2055
|
tags: ["environments"],
|
|
1457
2056
|
successDescription: "The environment variable has been deleted successfully"
|
|
1458
|
-
}).errors({
|
|
1459
|
-
|
|
1460
|
-
BAD_REQUEST: {}
|
|
1461
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1462
|
-
const deleteProjectContractV1 = oc.route({
|
|
2057
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
2058
|
+
const deleteProjectContractV1 = base.route({
|
|
1463
2059
|
path: "/v1/projects/{projectId}",
|
|
1464
2060
|
method: "DELETE",
|
|
1465
2061
|
summary: "Delete a project",
|
|
@@ -1467,7 +2063,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1467
2063
|
tags: ["projects"],
|
|
1468
2064
|
successDescription: "The project has been deleted successfully"
|
|
1469
2065
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1470
|
-
const updateProjectContractV1 =
|
|
2066
|
+
const updateProjectContractV1 = base.route({
|
|
1471
2067
|
path: "/v1/projects/{projectId}",
|
|
1472
2068
|
method: "PATCH",
|
|
1473
2069
|
summary: "Update a project",
|
|
@@ -1476,14 +2072,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1476
2072
|
successDescription: "The project has been updated successfully"
|
|
1477
2073
|
}).errors({
|
|
1478
2074
|
NOT_FOUND: {},
|
|
1479
|
-
BAD_REQUEST: {},
|
|
1480
2075
|
FORBIDDEN: {}
|
|
1481
2076
|
}).input(z.object({
|
|
1482
2077
|
projectId: z.string().describe("The ID of the project"),
|
|
1483
2078
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1484
2079
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1485
2080
|
})).output(projectOutputSchema);
|
|
1486
|
-
const deployEnvironmentContractV1 =
|
|
2081
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1487
2082
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1488
2083
|
method: "POST",
|
|
1489
2084
|
summary: "Deploy an environment",
|
|
@@ -1492,27 +2087,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1492
2087
|
successDescription: "The environment has been deployed successfully"
|
|
1493
2088
|
}).errors({
|
|
1494
2089
|
NOT_FOUND: {},
|
|
1495
|
-
|
|
2090
|
+
CONFLICT: {}
|
|
1496
2091
|
}).input(z.object({
|
|
1497
2092
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1498
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
2093
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
2094
|
+
settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
|
|
1499
2095
|
})).output(deploymentSchema);
|
|
1500
|
-
const uploadDeploymentArtifactContractV1 =
|
|
2096
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1501
2097
|
path: "/v1/deployments/upload",
|
|
1502
2098
|
method: "POST",
|
|
1503
2099
|
summary: "Upload deployment artifacts",
|
|
1504
2100
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1505
2101
|
tags: ["deployments"],
|
|
1506
2102
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1507
|
-
}).errors({
|
|
1508
|
-
NOT_FOUND: {},
|
|
1509
|
-
BAD_REQUEST: {}
|
|
1510
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
2103
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1511
2104
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1512
2105
|
token: z.string().describe("Token to identify the source archive"),
|
|
1513
2106
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1514
2107
|
}));
|
|
1515
|
-
const listDeploymentsContractV1 =
|
|
2108
|
+
const listDeploymentsContractV1 = base.route({
|
|
1516
2109
|
path: "/v1/projects/{projectId}/deployments",
|
|
1517
2110
|
method: "GET",
|
|
1518
2111
|
summary: "List project deployments",
|
|
@@ -1524,7 +2117,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1524
2117
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1525
2118
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1526
2119
|
})).output(z.array(deploymentSchema));
|
|
1527
|
-
const getDeploymentContractV1 =
|
|
2120
|
+
const getDeploymentContractV1 = base.route({
|
|
1528
2121
|
path: "/v1/deployments/{deploymentId}",
|
|
1529
2122
|
method: "GET",
|
|
1530
2123
|
summary: "Get a deployment",
|
|
@@ -1532,20 +2125,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1532
2125
|
tags: ["deployments"],
|
|
1533
2126
|
successDescription: "The deployment details"
|
|
1534
2127
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1535
|
-
const
|
|
2128
|
+
const logEntrySchema = z.object({
|
|
2129
|
+
timestamp: z.coerce.date(),
|
|
2130
|
+
type: z.enum([
|
|
2131
|
+
"START",
|
|
2132
|
+
"END",
|
|
2133
|
+
"INFO",
|
|
2134
|
+
"ERROR",
|
|
2135
|
+
"WARNING",
|
|
2136
|
+
"DEBUG"
|
|
2137
|
+
]),
|
|
2138
|
+
requestId: z.string(),
|
|
2139
|
+
content: z.string().optional(),
|
|
2140
|
+
method: z.string().optional(),
|
|
2141
|
+
durationInMs: z.number().optional()
|
|
2142
|
+
});
|
|
2143
|
+
const getLogsContractV1 = base.route({
|
|
1536
2144
|
path: "/v1/environments/{environmentId}/logs",
|
|
1537
2145
|
method: "GET",
|
|
1538
2146
|
summary: "Get logs",
|
|
1539
2147
|
description: "Get logs for an environment",
|
|
1540
2148
|
tags: ["environments"],
|
|
1541
2149
|
successDescription: "The logs"
|
|
1542
|
-
}).errors({
|
|
1543
|
-
NOT_FOUND: {},
|
|
1544
|
-
BAD_REQUEST: {}
|
|
1545
|
-
}).input(z.object({
|
|
2150
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1546
2151
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1547
|
-
since:
|
|
1548
|
-
until:
|
|
2152
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2153
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1549
2154
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1550
2155
|
level: z.array(z.enum([
|
|
1551
2156
|
"INFO",
|
|
@@ -1553,37 +2158,20 @@ const getLogsContractV1 = oc.route({
|
|
|
1553
2158
|
"WARNING",
|
|
1554
2159
|
"DEBUG"
|
|
1555
2160
|
])).optional().describe("Filter by log level"),
|
|
1556
|
-
search:
|
|
2161
|
+
search: logSearchSchema.optional().describe("Term to search for in log content"),
|
|
1557
2162
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1558
2163
|
})).output(z.object({
|
|
1559
|
-
logs: z.array(
|
|
1560
|
-
timestamp: z.coerce.date(),
|
|
1561
|
-
type: z.enum([
|
|
1562
|
-
"START",
|
|
1563
|
-
"END",
|
|
1564
|
-
"INFO",
|
|
1565
|
-
"ERROR",
|
|
1566
|
-
"WARNING",
|
|
1567
|
-
"DEBUG"
|
|
1568
|
-
]),
|
|
1569
|
-
requestId: z.string(),
|
|
1570
|
-
content: z.string().optional(),
|
|
1571
|
-
method: z.string().optional(),
|
|
1572
|
-
durationInMs: z.number().optional()
|
|
1573
|
-
})),
|
|
2164
|
+
logs: z.array(logEntrySchema),
|
|
1574
2165
|
nextToken: z.string().nullable()
|
|
1575
2166
|
}));
|
|
1576
|
-
const getLatestLogsContractV1 =
|
|
2167
|
+
const getLatestLogsContractV1 = base.route({
|
|
1577
2168
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1578
2169
|
method: "GET",
|
|
1579
2170
|
summary: "Get latest logs",
|
|
1580
2171
|
description: "Get the N most recent logs for an environment",
|
|
1581
2172
|
tags: ["environments"],
|
|
1582
2173
|
successDescription: "The latest logs"
|
|
1583
|
-
}).errors({
|
|
1584
|
-
NOT_FOUND: {},
|
|
1585
|
-
BAD_REQUEST: {}
|
|
1586
|
-
}).input(z.object({
|
|
2174
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1587
2175
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1588
2176
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1589
2177
|
level: z.array(z.enum([
|
|
@@ -1592,23 +2180,9 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1592
2180
|
"WARNING",
|
|
1593
2181
|
"DEBUG"
|
|
1594
2182
|
])).optional().describe("Filter by log level"),
|
|
1595
|
-
search:
|
|
1596
|
-
})).output(z.object({ logs: z.array(
|
|
1597
|
-
|
|
1598
|
-
type: z.enum([
|
|
1599
|
-
"START",
|
|
1600
|
-
"END",
|
|
1601
|
-
"INFO",
|
|
1602
|
-
"ERROR",
|
|
1603
|
-
"WARNING",
|
|
1604
|
-
"DEBUG"
|
|
1605
|
-
]),
|
|
1606
|
-
requestId: z.string(),
|
|
1607
|
-
content: z.string().optional(),
|
|
1608
|
-
method: z.string().optional(),
|
|
1609
|
-
durationInMs: z.number().optional()
|
|
1610
|
-
})) }));
|
|
1611
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
2183
|
+
search: logSearchSchema.optional().describe("Term to search for in log content")
|
|
2184
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
2185
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1612
2186
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1613
2187
|
method: "GET",
|
|
1614
2188
|
summary: "Get deployment logs",
|
|
@@ -1635,22 +2209,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1635
2209
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1636
2210
|
task_count: z.array(analyticsDataPointSchema)
|
|
1637
2211
|
});
|
|
1638
|
-
const getProjectAnalyticsContractV1 =
|
|
2212
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1639
2213
|
path: "/v1/analytics/{projectId}",
|
|
1640
2214
|
method: "GET",
|
|
1641
2215
|
summary: "Get project analytics",
|
|
1642
2216
|
description: "Get analytics data for a project over a time range",
|
|
1643
2217
|
tags: ["analytics"],
|
|
1644
2218
|
successDescription: "The project analytics data"
|
|
1645
|
-
}).errors({
|
|
1646
|
-
NOT_FOUND: {},
|
|
1647
|
-
BAD_REQUEST: {}
|
|
1648
|
-
}).input(z.object({
|
|
2219
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1649
2220
|
projectId: z.string().describe("The ID of the project"),
|
|
1650
2221
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1651
2222
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1652
2223
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1653
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2224
|
+
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 26784e5, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => isValidIanaTimeZone(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
1654
2225
|
metadata: z.object({
|
|
1655
2226
|
startTimestamp: z.number(),
|
|
1656
2227
|
endTimestamp: z.number(),
|
|
@@ -1660,7 +2231,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1660
2231
|
}),
|
|
1661
2232
|
timeSeries: analyticsTimeSeriesSchema
|
|
1662
2233
|
}));
|
|
1663
|
-
const
|
|
2234
|
+
const paginatedInsightsInputShape = {
|
|
2235
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2236
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2237
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2238
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2239
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2240
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2241
|
+
};
|
|
2242
|
+
const listIntentsContractV1 = base.route({
|
|
2243
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2244
|
+
method: "GET",
|
|
2245
|
+
summary: "List intents",
|
|
2246
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2247
|
+
tags: ["insights"],
|
|
2248
|
+
successDescription: "The grouped user intents"
|
|
2249
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2250
|
+
...paginatedInsightsInputShape,
|
|
2251
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2252
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2253
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2254
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2255
|
+
})).output(z.object({
|
|
2256
|
+
intents: z.array(z.object({
|
|
2257
|
+
id: z.string(),
|
|
2258
|
+
intentIds: z.array(z.string()).min(1),
|
|
2259
|
+
environmentId: z.string(),
|
|
2260
|
+
message: z.string(),
|
|
2261
|
+
toolName: z.string(),
|
|
2262
|
+
createdAt: z.coerce.date(),
|
|
2263
|
+
occurrenceCount: z.number().int().positive(),
|
|
2264
|
+
clientName: z.string().nullable(),
|
|
2265
|
+
clientId: z.string().nullable(),
|
|
2266
|
+
categories: z.array(z.object({
|
|
2267
|
+
id: z.string(),
|
|
2268
|
+
name: z.string(),
|
|
2269
|
+
color: intentCategoryColorSchema
|
|
2270
|
+
}))
|
|
2271
|
+
})),
|
|
2272
|
+
totalCount: z.number().int().nonnegative()
|
|
2273
|
+
}));
|
|
2274
|
+
const listFeedbacksContractV1 = base.route({
|
|
2275
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2276
|
+
method: "GET",
|
|
2277
|
+
summary: "List feedbacks",
|
|
2278
|
+
description: "List user feedback for an environment over a time range",
|
|
2279
|
+
tags: ["insights"],
|
|
2280
|
+
successDescription: "The user feedback"
|
|
2281
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2282
|
+
...paginatedInsightsInputShape,
|
|
2283
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2284
|
+
})).output(z.object({
|
|
2285
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2286
|
+
totalCount: z.number().int().nonnegative()
|
|
2287
|
+
}));
|
|
2288
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2289
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2290
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2291
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2292
|
+
method: "GET",
|
|
2293
|
+
summary: "List intent categories",
|
|
2294
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2295
|
+
tags: ["insights"],
|
|
2296
|
+
successDescription: "The intent categories"
|
|
2297
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2298
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2299
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2300
|
+
method: "POST",
|
|
2301
|
+
summary: "Create an intent category",
|
|
2302
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2303
|
+
tags: ["insights"],
|
|
2304
|
+
successDescription: "The created intent category"
|
|
2305
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2306
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2307
|
+
name: intentCategoryNameSchema,
|
|
2308
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2309
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2310
|
+
})).output(intentCategorySchema);
|
|
2311
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2312
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2313
|
+
method: "PATCH",
|
|
2314
|
+
summary: "Update an intent category",
|
|
2315
|
+
description: "Rename or recolor an intent category",
|
|
2316
|
+
tags: ["insights"],
|
|
2317
|
+
successDescription: "The updated intent category"
|
|
2318
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2319
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2320
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2321
|
+
name: intentCategoryNameSchema.optional(),
|
|
2322
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2323
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2324
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2325
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2326
|
+
method: "DELETE",
|
|
2327
|
+
summary: "Delete an intent category",
|
|
2328
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2329
|
+
tags: ["insights"],
|
|
2330
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2331
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2332
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2333
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2334
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2335
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2336
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2337
|
+
method: "POST",
|
|
2338
|
+
summary: "Link an intent category",
|
|
2339
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2340
|
+
tags: ["insights"],
|
|
2341
|
+
successDescription: "The intents have been linked successfully"
|
|
2342
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2343
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2344
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2345
|
+
intentIds: categorizableIntentIdsSchema
|
|
2346
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2347
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2348
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2349
|
+
method: "POST",
|
|
2350
|
+
summary: "Unlink an intent category",
|
|
2351
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2352
|
+
tags: ["insights"],
|
|
2353
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2354
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2355
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2356
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2357
|
+
intentIds: categorizableIntentIdsSchema
|
|
2358
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2359
|
+
const listTeamsContractV1 = base.route({
|
|
1664
2360
|
path: "/v1/teams",
|
|
1665
2361
|
method: "GET",
|
|
1666
2362
|
summary: "List teams",
|
|
@@ -1673,7 +2369,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1673
2369
|
createdAt: z.coerce.date(),
|
|
1674
2370
|
hasStripeAccount: z.boolean()
|
|
1675
2371
|
})));
|
|
1676
|
-
const
|
|
2372
|
+
const getTeamUsageContractV1 = base.route({
|
|
2373
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2374
|
+
method: "GET",
|
|
2375
|
+
summary: "Get team usage",
|
|
2376
|
+
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.",
|
|
2377
|
+
tags: ["teams"],
|
|
2378
|
+
successDescription: "The current billing window usage"
|
|
2379
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2380
|
+
teamId: z.string(),
|
|
2381
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2382
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2383
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2384
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2385
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2386
|
+
}));
|
|
2387
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1677
2388
|
path: "/v1/tunnels/ticket",
|
|
1678
2389
|
method: "GET",
|
|
1679
2390
|
summary: "Get a tunnel ticket",
|
|
@@ -1685,16 +2396,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1685
2396
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1686
2397
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1687
2398
|
}));
|
|
1688
|
-
const publishServerContractV1 =
|
|
2399
|
+
const publishServerContractV1 = base.route({
|
|
1689
2400
|
path: "/v1/distribution/publish",
|
|
1690
2401
|
method: "POST",
|
|
1691
2402
|
summary: "Publish a server to the MCP registry",
|
|
1692
2403
|
tags: ["distribution"],
|
|
1693
2404
|
successDescription: "The server has been published successfully"
|
|
1694
|
-
}).errors({
|
|
1695
|
-
NOT_FOUND: {},
|
|
1696
|
-
BAD_REQUEST: {}
|
|
1697
|
-
}).input(z.object({
|
|
2405
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1698
2406
|
projectId: z.string(),
|
|
1699
2407
|
domain: z.string(),
|
|
1700
2408
|
title: z.string().min(1).max(100),
|
|
@@ -1703,17 +2411,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1703
2411
|
iconSrc: z.url().max(255).optional(),
|
|
1704
2412
|
dryRun: z.boolean().optional()
|
|
1705
2413
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1706
|
-
const getServerInfoContractV1 =
|
|
2414
|
+
const getServerInfoContractV1 = base.route({
|
|
1707
2415
|
path: "/v1/distribution/get",
|
|
1708
2416
|
method: "GET",
|
|
1709
2417
|
summary: "Get server info",
|
|
1710
2418
|
description: "Get info about a server",
|
|
1711
2419
|
tags: ["distribution"],
|
|
1712
2420
|
successDescription: "The server info"
|
|
1713
|
-
}).errors({
|
|
1714
|
-
NOT_FOUND: {},
|
|
1715
|
-
BAD_REQUEST: {}
|
|
1716
|
-
}).input(z.object({
|
|
2421
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1717
2422
|
projectId: z.string(),
|
|
1718
2423
|
domain: z.string()
|
|
1719
2424
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1732,7 +2437,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1732
2437
|
isPlaygroundEnabled: z.boolean(),
|
|
1733
2438
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1734
2439
|
});
|
|
1735
|
-
const getPlaygroundContractV1 =
|
|
2440
|
+
const getPlaygroundContractV1 = base.route({
|
|
1736
2441
|
path: "/v1/environments/{environmentId}/playground",
|
|
1737
2442
|
method: "GET",
|
|
1738
2443
|
summary: "Get playground configuration",
|
|
@@ -1740,17 +2445,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1740
2445
|
tags: ["environments"],
|
|
1741
2446
|
successDescription: "The playground configuration"
|
|
1742
2447
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1743
|
-
const upsertPlaygroundContractV1 =
|
|
2448
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1744
2449
|
path: "/v1/environments/{environmentId}/playground",
|
|
1745
2450
|
method: "PUT",
|
|
1746
2451
|
summary: "Update playground configuration",
|
|
1747
2452
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1748
2453
|
tags: ["environments"],
|
|
1749
2454
|
successDescription: "The updated playground configuration"
|
|
1750
|
-
}).errors({
|
|
1751
|
-
NOT_FOUND: {},
|
|
1752
|
-
BAD_REQUEST: {}
|
|
1753
|
-
}).input(z.object({
|
|
2455
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1754
2456
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1755
2457
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1756
2458
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1758,7 +2460,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1758
2460
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1759
2461
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1760
2462
|
})).output(playgroundOutputSchema);
|
|
1761
|
-
const createBeaconContractV1 =
|
|
2463
|
+
const createBeaconContractV1 = base.route({
|
|
1762
2464
|
path: "/v1/beacon/audits",
|
|
1763
2465
|
method: "POST",
|
|
1764
2466
|
summary: "Create a beacon audit",
|
|
@@ -1767,7 +2469,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1767
2469
|
successDescription: "The audit has been created"
|
|
1768
2470
|
}).errors({
|
|
1769
2471
|
NOT_FOUND: {},
|
|
1770
|
-
BAD_REQUEST: {},
|
|
1771
2472
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1772
2473
|
}).input(z.object({
|
|
1773
2474
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1775,7 +2476,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1775
2476
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1776
2477
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1777
2478
|
})).output(z.object({ id: z.string() }));
|
|
1778
|
-
const getBeaconContractV1 =
|
|
2479
|
+
const getBeaconContractV1 = base.route({
|
|
1779
2480
|
path: "/v1/beacon/audits/{auditId}",
|
|
1780
2481
|
method: "GET",
|
|
1781
2482
|
summary: "Get a beacon audit",
|
|
@@ -1790,9 +2491,73 @@ const getBeaconContractV1 = oc.route({
|
|
|
1790
2491
|
createdAt: z.coerce.date(),
|
|
1791
2492
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1792
2493
|
}));
|
|
2494
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2495
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2496
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2497
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2498
|
+
const createSubmissionContractV1 = base.route({
|
|
2499
|
+
path: "/v1/submissions",
|
|
2500
|
+
method: "POST",
|
|
2501
|
+
summary: "Create a submission package",
|
|
2502
|
+
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.",
|
|
2503
|
+
tags: ["submissions"],
|
|
2504
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2505
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2506
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2507
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2508
|
+
})).output(submissionSchema);
|
|
2509
|
+
const listSubmissionsContractV1 = base.route({
|
|
2510
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2511
|
+
method: "GET",
|
|
2512
|
+
summary: "List submission packages",
|
|
2513
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2514
|
+
tags: ["submissions"],
|
|
2515
|
+
successDescription: "The list of submission packages"
|
|
2516
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2517
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2518
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2519
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2520
|
+
})).output(z.array(submissionSchema));
|
|
2521
|
+
const getSubmissionContractV1 = base.route({
|
|
2522
|
+
path: "/v1/submissions/{submissionId}",
|
|
2523
|
+
method: "GET",
|
|
2524
|
+
summary: "Get a submission package",
|
|
2525
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2526
|
+
tags: ["submissions"],
|
|
2527
|
+
successDescription: "The submission package"
|
|
2528
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2529
|
+
const updateSubmissionContractV1 = base.route({
|
|
2530
|
+
path: "/v1/submissions/{submissionId}",
|
|
2531
|
+
method: "PUT",
|
|
2532
|
+
summary: "Update a submission package",
|
|
2533
|
+
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.",
|
|
2534
|
+
tags: ["submissions"],
|
|
2535
|
+
successDescription: "The updated submission package"
|
|
2536
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2537
|
+
submissionId: submissionIdSchema,
|
|
2538
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2539
|
+
formData: claudeSubmissionUpdateSchema
|
|
2540
|
+
}), z.object({
|
|
2541
|
+
submissionId: submissionIdSchema,
|
|
2542
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2543
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2544
|
+
})])).output(submissionSchema);
|
|
1793
2545
|
const contract = {
|
|
1794
|
-
teams: {
|
|
2546
|
+
teams: {
|
|
2547
|
+
list: { v1: listTeamsContractV1 },
|
|
2548
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2549
|
+
},
|
|
1795
2550
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2551
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2552
|
+
intentCategories: {
|
|
2553
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2554
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2555
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2556
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2557
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2558
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2559
|
+
},
|
|
2560
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1796
2561
|
deployments: {
|
|
1797
2562
|
list: { v1: listDeploymentsContractV1 },
|
|
1798
2563
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1802,6 +2567,7 @@ const contract = {
|
|
|
1802
2567
|
environments: {
|
|
1803
2568
|
create: { v1: createEnvironmentContractV1 },
|
|
1804
2569
|
get: { v1: getEnvironmentContractV1 },
|
|
2570
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1805
2571
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1806
2572
|
getLogs: { v1: getLogsContractV1 },
|
|
1807
2573
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1812,6 +2578,12 @@ const contract = {
|
|
|
1812
2578
|
update: { v1: updateEnvironmentVariableContractV1 },
|
|
1813
2579
|
delete: { v1: deleteEnvironmentVariableContractV1 }
|
|
1814
2580
|
},
|
|
2581
|
+
telemetryDestinations: {
|
|
2582
|
+
list: { v1: listTelemetryDestinationsContractV1 },
|
|
2583
|
+
create: { v1: createTelemetryDestinationContractV1 },
|
|
2584
|
+
update: { v1: updateTelemetryDestinationContractV1 },
|
|
2585
|
+
delete: { v1: deleteTelemetryDestinationContractV1 }
|
|
2586
|
+
},
|
|
1815
2587
|
projects: {
|
|
1816
2588
|
update: { v1: updateProjectContractV1 },
|
|
1817
2589
|
get: { v1: getProjectContractV1 },
|
|
@@ -1831,7 +2603,39 @@ const contract = {
|
|
|
1831
2603
|
beacon: {
|
|
1832
2604
|
create: { v1: createBeaconContractV1 },
|
|
1833
2605
|
get: { v1: getBeaconContractV1 }
|
|
2606
|
+
},
|
|
2607
|
+
submissions: {
|
|
2608
|
+
create: { v1: createSubmissionContractV1 },
|
|
2609
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2610
|
+
get: { v1: getSubmissionContractV1 },
|
|
2611
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2612
|
+
}
|
|
2613
|
+
};
|
|
2614
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2615
|
+
const contractForDocs = {
|
|
2616
|
+
...contract,
|
|
2617
|
+
deployments: deploymentsForDocs
|
|
2618
|
+
};
|
|
2619
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2620
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2621
|
+
info: {
|
|
2622
|
+
title: "Alpic API",
|
|
2623
|
+
version: "1.0.0"
|
|
2624
|
+
},
|
|
2625
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2626
|
+
security: [{ bearerAuth: [] }],
|
|
2627
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2628
|
+
type: "http",
|
|
2629
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2630
|
+
scheme: "bearer"
|
|
2631
|
+
} } },
|
|
2632
|
+
commonSchemas: {
|
|
2633
|
+
Submission: { schema: submissionSchema },
|
|
2634
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2635
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2636
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2637
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
1834
2638
|
}
|
|
1835
2639
|
};
|
|
1836
2640
|
//#endregion
|
|
1837
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2641
|
+
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 };
|