@alpic-ai/api 0.0.0-staging.ff03b3f → 0.0.0-staging.g01356a0
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 +112 -75
- package/dist/index.mjs +1213 -58
- package/package.json +17 -10
package/dist/index.mjs
CHANGED
|
@@ -1,18 +1,195 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
|
+
import * as z$1 from "zod/v4";
|
|
2
3
|
import { oc } from "@orpc/contract";
|
|
3
4
|
import ms from "ms";
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.29.0_supports-color@7.2.0_zod@4.4.3/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
|
+
/**
|
|
7
|
+
* Reusable URL validation that disallows javascript: scheme
|
|
8
|
+
*/
|
|
9
|
+
const SafeUrlSchema = z$1.url().superRefine((val, ctx) => {
|
|
10
|
+
if (!URL.canParse(val)) {
|
|
11
|
+
ctx.addIssue({
|
|
12
|
+
code: z$1.ZodIssueCode.custom,
|
|
13
|
+
message: "URL must be parseable",
|
|
14
|
+
fatal: true
|
|
15
|
+
});
|
|
16
|
+
return z$1.NEVER;
|
|
17
|
+
}
|
|
18
|
+
}).refine((url) => {
|
|
19
|
+
const u = new URL(url);
|
|
20
|
+
return u.protocol !== "javascript:" && u.protocol !== "data:" && u.protocol !== "vbscript:";
|
|
21
|
+
}, { message: "URL cannot use javascript:, data:, or vbscript: scheme" });
|
|
22
|
+
/**
|
|
23
|
+
* RFC 9728 OAuth Protected Resource Metadata
|
|
24
|
+
*/
|
|
25
|
+
const OAuthProtectedResourceMetadataSchema = z$1.looseObject({
|
|
26
|
+
resource: z$1.string().url(),
|
|
27
|
+
authorization_servers: z$1.array(SafeUrlSchema).optional(),
|
|
28
|
+
jwks_uri: z$1.string().url().optional(),
|
|
29
|
+
scopes_supported: z$1.array(z$1.string()).optional(),
|
|
30
|
+
bearer_methods_supported: z$1.array(z$1.string()).optional(),
|
|
31
|
+
resource_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
32
|
+
resource_name: z$1.string().optional(),
|
|
33
|
+
resource_documentation: z$1.string().optional(),
|
|
34
|
+
resource_policy_uri: z$1.string().url().optional(),
|
|
35
|
+
resource_tos_uri: z$1.string().url().optional(),
|
|
36
|
+
tls_client_certificate_bound_access_tokens: z$1.boolean().optional(),
|
|
37
|
+
authorization_details_types_supported: z$1.array(z$1.string()).optional(),
|
|
38
|
+
dpop_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
39
|
+
dpop_bound_access_tokens_required: z$1.boolean().optional()
|
|
40
|
+
});
|
|
41
|
+
/**
|
|
42
|
+
* RFC 8414 OAuth 2.0 Authorization Server Metadata
|
|
43
|
+
*/
|
|
44
|
+
const OAuthMetadataSchema = z$1.looseObject({
|
|
45
|
+
issuer: z$1.string(),
|
|
46
|
+
authorization_endpoint: SafeUrlSchema,
|
|
47
|
+
token_endpoint: SafeUrlSchema,
|
|
48
|
+
registration_endpoint: SafeUrlSchema.optional(),
|
|
49
|
+
scopes_supported: z$1.array(z$1.string()).optional(),
|
|
50
|
+
response_types_supported: z$1.array(z$1.string()),
|
|
51
|
+
response_modes_supported: z$1.array(z$1.string()).optional(),
|
|
52
|
+
grant_types_supported: z$1.array(z$1.string()).optional(),
|
|
53
|
+
token_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
54
|
+
token_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
55
|
+
service_documentation: SafeUrlSchema.optional(),
|
|
56
|
+
revocation_endpoint: SafeUrlSchema.optional(),
|
|
57
|
+
revocation_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
58
|
+
revocation_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
59
|
+
introspection_endpoint: z$1.string().optional(),
|
|
60
|
+
introspection_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
61
|
+
introspection_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
62
|
+
code_challenge_methods_supported: z$1.array(z$1.string()).optional(),
|
|
63
|
+
client_id_metadata_document_supported: z$1.boolean().optional()
|
|
64
|
+
});
|
|
65
|
+
/**
|
|
66
|
+
* OpenID Connect Discovery 1.0 Provider Metadata
|
|
67
|
+
* see: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
|
|
68
|
+
*/
|
|
69
|
+
const OpenIdProviderMetadataSchema = z$1.looseObject({
|
|
70
|
+
issuer: z$1.string(),
|
|
71
|
+
authorization_endpoint: SafeUrlSchema,
|
|
72
|
+
token_endpoint: SafeUrlSchema,
|
|
73
|
+
userinfo_endpoint: SafeUrlSchema.optional(),
|
|
74
|
+
jwks_uri: SafeUrlSchema,
|
|
75
|
+
registration_endpoint: SafeUrlSchema.optional(),
|
|
76
|
+
scopes_supported: z$1.array(z$1.string()).optional(),
|
|
77
|
+
response_types_supported: z$1.array(z$1.string()),
|
|
78
|
+
response_modes_supported: z$1.array(z$1.string()).optional(),
|
|
79
|
+
grant_types_supported: z$1.array(z$1.string()).optional(),
|
|
80
|
+
acr_values_supported: z$1.array(z$1.string()).optional(),
|
|
81
|
+
subject_types_supported: z$1.array(z$1.string()),
|
|
82
|
+
id_token_signing_alg_values_supported: z$1.array(z$1.string()),
|
|
83
|
+
id_token_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
84
|
+
id_token_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
|
|
85
|
+
userinfo_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
86
|
+
userinfo_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
87
|
+
userinfo_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
|
|
88
|
+
request_object_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
89
|
+
request_object_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
90
|
+
request_object_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
|
|
91
|
+
token_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
92
|
+
token_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
93
|
+
display_values_supported: z$1.array(z$1.string()).optional(),
|
|
94
|
+
claim_types_supported: z$1.array(z$1.string()).optional(),
|
|
95
|
+
claims_supported: z$1.array(z$1.string()).optional(),
|
|
96
|
+
service_documentation: z$1.string().optional(),
|
|
97
|
+
claims_locales_supported: z$1.array(z$1.string()).optional(),
|
|
98
|
+
ui_locales_supported: z$1.array(z$1.string()).optional(),
|
|
99
|
+
claims_parameter_supported: z$1.boolean().optional(),
|
|
100
|
+
request_parameter_supported: z$1.boolean().optional(),
|
|
101
|
+
request_uri_parameter_supported: z$1.boolean().optional(),
|
|
102
|
+
require_request_uri_registration: z$1.boolean().optional(),
|
|
103
|
+
op_policy_uri: SafeUrlSchema.optional(),
|
|
104
|
+
op_tos_uri: SafeUrlSchema.optional(),
|
|
105
|
+
client_id_metadata_document_supported: z$1.boolean().optional()
|
|
106
|
+
});
|
|
107
|
+
/**
|
|
108
|
+
* OpenID Connect Discovery metadata that may include OAuth 2.0 fields
|
|
109
|
+
* This schema represents the real-world scenario where OIDC providers
|
|
110
|
+
* return a mix of OpenID Connect and OAuth 2.0 metadata fields
|
|
111
|
+
*/
|
|
112
|
+
const OpenIdProviderDiscoveryMetadataSchema = z$1.object({
|
|
113
|
+
...OpenIdProviderMetadataSchema.shape,
|
|
114
|
+
...OAuthMetadataSchema.pick({ code_challenge_methods_supported: true }).shape
|
|
115
|
+
});
|
|
116
|
+
z$1.object({
|
|
117
|
+
access_token: z$1.string(),
|
|
118
|
+
id_token: z$1.string().optional(),
|
|
119
|
+
token_type: z$1.string(),
|
|
120
|
+
expires_in: z$1.coerce.number().optional(),
|
|
121
|
+
scope: z$1.string().optional(),
|
|
122
|
+
refresh_token: z$1.string().optional()
|
|
123
|
+
}).strip();
|
|
124
|
+
z$1.object({
|
|
125
|
+
error: z$1.string(),
|
|
126
|
+
error_description: z$1.string().optional(),
|
|
127
|
+
error_uri: z$1.string().optional()
|
|
128
|
+
});
|
|
129
|
+
/**
|
|
130
|
+
* Optional version of SafeUrlSchema that allows empty string for retrocompatibility on tos_uri and logo_uri
|
|
131
|
+
*/
|
|
132
|
+
const OptionalSafeUrlSchema = SafeUrlSchema.optional().or(z$1.literal("").transform(() => void 0));
|
|
133
|
+
/**
|
|
134
|
+
* RFC 7591 OAuth 2.0 Dynamic Client Registration metadata
|
|
135
|
+
*/
|
|
136
|
+
const OAuthClientMetadataSchema = z$1.object({
|
|
137
|
+
redirect_uris: z$1.array(SafeUrlSchema),
|
|
138
|
+
token_endpoint_auth_method: z$1.string().optional(),
|
|
139
|
+
grant_types: z$1.array(z$1.string()).optional(),
|
|
140
|
+
response_types: z$1.array(z$1.string()).optional(),
|
|
141
|
+
client_name: z$1.string().optional(),
|
|
142
|
+
client_uri: SafeUrlSchema.optional(),
|
|
143
|
+
logo_uri: OptionalSafeUrlSchema,
|
|
144
|
+
scope: z$1.string().optional(),
|
|
145
|
+
contacts: z$1.array(z$1.string()).optional(),
|
|
146
|
+
tos_uri: OptionalSafeUrlSchema,
|
|
147
|
+
policy_uri: z$1.string().optional(),
|
|
148
|
+
jwks_uri: SafeUrlSchema.optional(),
|
|
149
|
+
jwks: z$1.any().optional(),
|
|
150
|
+
software_id: z$1.string().optional(),
|
|
151
|
+
software_version: z$1.string().optional(),
|
|
152
|
+
software_statement: z$1.string().optional()
|
|
153
|
+
}).strip();
|
|
154
|
+
/**
|
|
155
|
+
* RFC 7591 OAuth 2.0 Dynamic Client Registration client information
|
|
156
|
+
*/
|
|
157
|
+
const OAuthClientInformationSchema = z$1.object({
|
|
158
|
+
client_id: z$1.string(),
|
|
159
|
+
client_secret: z$1.string().optional(),
|
|
160
|
+
client_id_issued_at: z$1.number().optional(),
|
|
161
|
+
client_secret_expires_at: z$1.number().optional()
|
|
162
|
+
}).strip();
|
|
163
|
+
OAuthClientMetadataSchema.merge(OAuthClientInformationSchema);
|
|
164
|
+
z$1.object({
|
|
165
|
+
error: z$1.string(),
|
|
166
|
+
error_description: z$1.string().optional()
|
|
167
|
+
}).strip();
|
|
168
|
+
z$1.object({
|
|
169
|
+
token: z$1.string(),
|
|
170
|
+
token_type_hint: z$1.string().optional()
|
|
171
|
+
}).strip();
|
|
172
|
+
//#endregion
|
|
4
173
|
//#region ../domains/dist/index.mjs
|
|
174
|
+
const AI_PLATFORMS = ["chatgpt", "claudeai"];
|
|
175
|
+
const platformSchema = z.enum(AI_PLATFORMS);
|
|
176
|
+
const PLATFORM_LABELS = {
|
|
177
|
+
chatgpt: "ChatGPT",
|
|
178
|
+
claudeai: "Claude.ai"
|
|
179
|
+
};
|
|
180
|
+
const WAF_PLATFORMS = [
|
|
181
|
+
"akamai",
|
|
182
|
+
"cloudflare",
|
|
183
|
+
"fastly"
|
|
184
|
+
];
|
|
185
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
186
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
5
187
|
const auditStatusSchema = z.enum([
|
|
6
188
|
"pending",
|
|
7
189
|
"partial",
|
|
8
190
|
"completed",
|
|
9
191
|
"failed"
|
|
10
192
|
]);
|
|
11
|
-
const platformSchema = z.enum(["chatgpt", "claudeai"]);
|
|
12
|
-
const PLATFORM_LABELS = {
|
|
13
|
-
chatgpt: "ChatGPT",
|
|
14
|
-
claudeai: "Claude.ai"
|
|
15
|
-
};
|
|
16
193
|
const checkSeveritySchema = z.enum([
|
|
17
194
|
"error",
|
|
18
195
|
"warning",
|
|
@@ -72,6 +249,991 @@ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreen
|
|
|
72
249
|
chatgpt: widgetScreenshotSchema.optional(),
|
|
73
250
|
claudeai: widgetScreenshotSchema.optional()
|
|
74
251
|
}) });
|
|
252
|
+
z.object({
|
|
253
|
+
id: z.string(),
|
|
254
|
+
environmentId: z.string(),
|
|
255
|
+
clientId: z.string(),
|
|
256
|
+
clientSecret: z.string(),
|
|
257
|
+
clientScopes: z.array(z.string())
|
|
258
|
+
});
|
|
259
|
+
const deploymentStatusSchema$1 = z.enum([
|
|
260
|
+
"ongoing",
|
|
261
|
+
"deployed",
|
|
262
|
+
"failed",
|
|
263
|
+
"canceled"
|
|
264
|
+
]);
|
|
265
|
+
z.object({
|
|
266
|
+
timestamp: z.coerce.date().optional(),
|
|
267
|
+
content: z.string().optional()
|
|
268
|
+
});
|
|
269
|
+
const deploymentSummarySchema = z.object({
|
|
270
|
+
id: z.string(),
|
|
271
|
+
status: deploymentStatusSchema$1,
|
|
272
|
+
sourceBucket: z.string().nullable(),
|
|
273
|
+
sourceObjectKey: z.string().nullable(),
|
|
274
|
+
sourceRef: z.string().nullable(),
|
|
275
|
+
sourceCommitId: z.string().nullable(),
|
|
276
|
+
sourceCommitMessage: z.string().nullable(),
|
|
277
|
+
environmentId: z.string(),
|
|
278
|
+
authorUsername: z.string().nullable(),
|
|
279
|
+
authorAvatarUrl: z.string().nullable(),
|
|
280
|
+
startedAt: z.coerce.date().nullable(),
|
|
281
|
+
completedAt: z.coerce.date().nullable(),
|
|
282
|
+
isCurrent: z.boolean().optional(),
|
|
283
|
+
createdAt: z.coerce.date(),
|
|
284
|
+
updatedAt: z.coerce.date()
|
|
285
|
+
});
|
|
286
|
+
/**
|
|
287
|
+
* Public environment
|
|
288
|
+
*
|
|
289
|
+
* Answers anonymously and exposes no OAuth metadata.
|
|
290
|
+
*/
|
|
291
|
+
const publicEnvironmentSchema = z.object({
|
|
292
|
+
allowsAnonymous: z.literal(true),
|
|
293
|
+
oAuthMetadata: z.strictObject({})
|
|
294
|
+
});
|
|
295
|
+
/**
|
|
296
|
+
* Protected environment with an external resource metadata URL
|
|
297
|
+
*
|
|
298
|
+
* An external resource metadata URL is returned in the WWW-Authenticate header during the first 401 response.
|
|
299
|
+
* Everything that follows is handled outside of the MCP server scope.
|
|
300
|
+
*/
|
|
301
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
302
|
+
allowsAnonymous: z.boolean(),
|
|
303
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
304
|
+
scope: z.string().optional()
|
|
305
|
+
});
|
|
306
|
+
/**
|
|
307
|
+
* Protected environment with an external authorization server URL
|
|
308
|
+
*
|
|
309
|
+
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
310
|
+
* An external authorization server URL is returned when requesting the endpoint.
|
|
311
|
+
* Everything that follows is handled outside of the MCP server scope.
|
|
312
|
+
*/
|
|
313
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
314
|
+
allowsAnonymous: z.boolean(),
|
|
315
|
+
oAuthMetadata: z.object({
|
|
316
|
+
externalAuthorizationServerUrl: z.url(),
|
|
317
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
318
|
+
}),
|
|
319
|
+
scope: z.string().optional()
|
|
320
|
+
});
|
|
321
|
+
/**
|
|
322
|
+
* Standalone protected environment
|
|
323
|
+
*
|
|
324
|
+
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
325
|
+
* The server itself exposes the /.well-known/oauth-authorization-server endpoint.
|
|
326
|
+
*/
|
|
327
|
+
const standaloneEnvironmentSchema = z.object({
|
|
328
|
+
allowsAnonymous: z.boolean(),
|
|
329
|
+
oAuthMetadata: z.object({
|
|
330
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
331
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
332
|
+
}),
|
|
333
|
+
scope: z.string().optional()
|
|
334
|
+
});
|
|
335
|
+
/**
|
|
336
|
+
* Protected environment without OAuth discovery
|
|
337
|
+
*
|
|
338
|
+
* The server enforces authentication but exposes no OAuth discovery metadata.
|
|
339
|
+
* Neither /.well-known/oauth-protected-resource nor /.well-known/oauth-authorization-server
|
|
340
|
+
* are advertised. Clients must obtain credentials out-of-band.
|
|
341
|
+
*/
|
|
342
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
343
|
+
allowsAnonymous: z.literal(false),
|
|
344
|
+
oAuthMetadata: z.strictObject({}),
|
|
345
|
+
scope: z.string().optional()
|
|
346
|
+
});
|
|
347
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
348
|
+
isPublic: z.literal(true),
|
|
349
|
+
oAuthMetadata: z.undefined().optional()
|
|
350
|
+
});
|
|
351
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
352
|
+
isPublic: z.literal(false),
|
|
353
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
354
|
+
scope: z.string().optional()
|
|
355
|
+
});
|
|
356
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
357
|
+
isPublic: z.literal(false),
|
|
358
|
+
oAuthMetadata: z.object({
|
|
359
|
+
externalAuthorizationServerUrl: z.url(),
|
|
360
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
361
|
+
}),
|
|
362
|
+
scope: z.string().optional()
|
|
363
|
+
});
|
|
364
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
365
|
+
isPublic: z.literal(false),
|
|
366
|
+
oAuthMetadata: z.object({
|
|
367
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
368
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
369
|
+
}),
|
|
370
|
+
scope: z.string().optional()
|
|
371
|
+
});
|
|
372
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
373
|
+
isPublic: z.literal(false),
|
|
374
|
+
oAuthMetadata: z.strictObject({}),
|
|
375
|
+
scope: z.string().optional()
|
|
376
|
+
});
|
|
377
|
+
z.union([
|
|
378
|
+
publicEnvironmentSchema,
|
|
379
|
+
externalResourceMetadataEnvironmentSchema,
|
|
380
|
+
externalAuthorizationServerEnvironmentSchema,
|
|
381
|
+
standaloneEnvironmentSchema,
|
|
382
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
383
|
+
legacyPublicEnvironmentSchema,
|
|
384
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
385
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
386
|
+
legacyStandaloneEnvironmentSchema,
|
|
387
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
388
|
+
]);
|
|
389
|
+
const playgroundModelSchema = z.enum([
|
|
390
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
391
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
392
|
+
"openai.gpt-5.4",
|
|
393
|
+
"openai.gpt-5.5"
|
|
394
|
+
]);
|
|
395
|
+
const environmentDomainSchema = z.object({
|
|
396
|
+
name: z.string(),
|
|
397
|
+
status: z.enum([
|
|
398
|
+
"ongoing",
|
|
399
|
+
"deployed",
|
|
400
|
+
"failed"
|
|
401
|
+
]),
|
|
402
|
+
createdAt: z.coerce.date(),
|
|
403
|
+
updatedAt: z.coerce.date()
|
|
404
|
+
});
|
|
405
|
+
const environmentSchema$1 = z.object({
|
|
406
|
+
id: z.string(),
|
|
407
|
+
name: z.string(),
|
|
408
|
+
sourceBranch: z.string().nullable(),
|
|
409
|
+
mcpServerUrl: z.string(),
|
|
410
|
+
activeDeployment: deploymentSummarySchema.optional(),
|
|
411
|
+
latestDeployment: deploymentSummarySchema.optional(),
|
|
412
|
+
openaiAppsChallenge: z.string().nullable().optional(),
|
|
413
|
+
isPlaygroundEnabled: z.boolean(),
|
|
414
|
+
playgroundModel: playgroundModelSchema,
|
|
415
|
+
isIpWhitelistEnabled: z.boolean(),
|
|
416
|
+
ipAllowlist: z.array(z.string()).nullable(),
|
|
417
|
+
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
418
|
+
projectId: z.string(),
|
|
419
|
+
createdAt: z.coerce.date(),
|
|
420
|
+
updatedAt: z.coerce.date()
|
|
421
|
+
});
|
|
422
|
+
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
423
|
+
z.object({
|
|
424
|
+
sessionReplayEnabled: z.boolean(),
|
|
425
|
+
collectRequestPayload: z.boolean(),
|
|
426
|
+
collectResponsePayload: z.boolean(),
|
|
427
|
+
collectErrorMessage: z.boolean(),
|
|
428
|
+
collectUserData: z.boolean(),
|
|
429
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
430
|
+
});
|
|
431
|
+
z.object({
|
|
432
|
+
id: z.string(),
|
|
433
|
+
createdAt: z.coerce.date(),
|
|
434
|
+
environmentId: z.string(),
|
|
435
|
+
content: z.string(),
|
|
436
|
+
source: z.enum(["model", "user"])
|
|
437
|
+
});
|
|
438
|
+
z.object({
|
|
439
|
+
content: z.string(),
|
|
440
|
+
source: z.enum(["model", "user"])
|
|
441
|
+
});
|
|
442
|
+
const intentCategoryColorSchema = z.enum([
|
|
443
|
+
"red",
|
|
444
|
+
"orange",
|
|
445
|
+
"yellow",
|
|
446
|
+
"green",
|
|
447
|
+
"blue",
|
|
448
|
+
"purple",
|
|
449
|
+
"pink",
|
|
450
|
+
"gray"
|
|
451
|
+
]);
|
|
452
|
+
intentCategoryColorSchema.options;
|
|
453
|
+
const intentCategorySchema = z.object({
|
|
454
|
+
id: z.string(),
|
|
455
|
+
createdAt: z.coerce.date(),
|
|
456
|
+
environmentId: z.string(),
|
|
457
|
+
name: z.string(),
|
|
458
|
+
color: intentCategoryColorSchema
|
|
459
|
+
});
|
|
460
|
+
z.object({
|
|
461
|
+
id: z.string(),
|
|
462
|
+
name: z.string(),
|
|
463
|
+
color: intentCategoryColorSchema,
|
|
464
|
+
intentCount: z.number().int().nonnegative()
|
|
465
|
+
});
|
|
466
|
+
z.object({
|
|
467
|
+
id: z.string(),
|
|
468
|
+
createdAt: z.coerce.date(),
|
|
469
|
+
environmentId: z.string(),
|
|
470
|
+
toolName: z.string(),
|
|
471
|
+
message: z.string(),
|
|
472
|
+
categories: z.array(intentCategorySchema)
|
|
473
|
+
});
|
|
474
|
+
const signalCategorySchema = z.object({
|
|
475
|
+
id: z.string(),
|
|
476
|
+
name: z.string(),
|
|
477
|
+
color: intentCategoryColorSchema
|
|
478
|
+
});
|
|
479
|
+
z.discriminatedUnion("kind", [
|
|
480
|
+
z.object({
|
|
481
|
+
kind: z.literal("new"),
|
|
482
|
+
category: signalCategorySchema,
|
|
483
|
+
currentCount: z.number().int().nonnegative(),
|
|
484
|
+
currentShare: z.number()
|
|
485
|
+
}),
|
|
486
|
+
z.object({
|
|
487
|
+
kind: z.literal("resurging"),
|
|
488
|
+
category: signalCategorySchema,
|
|
489
|
+
currentCount: z.number().int().nonnegative(),
|
|
490
|
+
daysQuiet: z.number(),
|
|
491
|
+
currentShare: z.number()
|
|
492
|
+
}),
|
|
493
|
+
z.object({
|
|
494
|
+
kind: z.literal("spike"),
|
|
495
|
+
category: signalCategorySchema,
|
|
496
|
+
currentCount: z.number().int().nonnegative(),
|
|
497
|
+
previousCount: z.number().int().nonnegative(),
|
|
498
|
+
currentShare: z.number(),
|
|
499
|
+
previousShare: z.number(),
|
|
500
|
+
changeRatio: z.number()
|
|
501
|
+
}),
|
|
502
|
+
z.object({
|
|
503
|
+
kind: z.literal("declining"),
|
|
504
|
+
category: signalCategorySchema,
|
|
505
|
+
currentCount: z.number().int().nonnegative(),
|
|
506
|
+
previousCount: z.number().int().nonnegative(),
|
|
507
|
+
currentShare: z.number(),
|
|
508
|
+
previousShare: z.number(),
|
|
509
|
+
changeRatio: z.number()
|
|
510
|
+
})
|
|
511
|
+
]);
|
|
512
|
+
z.discriminatedUnion("kind", [z.object({
|
|
513
|
+
kind: z.literal("existing"),
|
|
514
|
+
categoryId: z.string(),
|
|
515
|
+
categoryName: z.string(),
|
|
516
|
+
intentIds: z.array(z.string())
|
|
517
|
+
}), z.object({
|
|
518
|
+
kind: z.literal("new"),
|
|
519
|
+
categoryName: z.string(),
|
|
520
|
+
intentIds: z.array(z.string())
|
|
521
|
+
})]);
|
|
522
|
+
z.object({
|
|
523
|
+
id: z.string(),
|
|
524
|
+
teamId: z.string(),
|
|
525
|
+
email: z.string(),
|
|
526
|
+
expiresAt: z.coerce.date(),
|
|
527
|
+
createdAt: z.coerce.date(),
|
|
528
|
+
updatedAt: z.coerce.date()
|
|
529
|
+
});
|
|
530
|
+
z.enum([
|
|
531
|
+
"INFO",
|
|
532
|
+
"WARNING",
|
|
533
|
+
"DEBUG",
|
|
534
|
+
"ERROR"
|
|
535
|
+
]);
|
|
536
|
+
const runtimeSchema = z.enum([
|
|
537
|
+
"python3.13",
|
|
538
|
+
"python3.14",
|
|
539
|
+
"node22",
|
|
540
|
+
"node24"
|
|
541
|
+
]);
|
|
542
|
+
const transportSchema = z.enum([
|
|
543
|
+
"stdio",
|
|
544
|
+
"sse",
|
|
545
|
+
"streamablehttp"
|
|
546
|
+
]);
|
|
547
|
+
z.object({
|
|
548
|
+
id: z.string(),
|
|
549
|
+
name: z.string(),
|
|
550
|
+
teamId: z.string(),
|
|
551
|
+
sourceRepository: z.string().nullable(),
|
|
552
|
+
createdAt: z.coerce.date().optional(),
|
|
553
|
+
runtime: runtimeSchema,
|
|
554
|
+
transport: transportSchema.nullable(),
|
|
555
|
+
rootDirectory: z.string().nullable(),
|
|
556
|
+
installCommand: z.string().nullable(),
|
|
557
|
+
buildCommand: z.string().nullable(),
|
|
558
|
+
buildOutputDir: z.string().nullable(),
|
|
559
|
+
startCommand: z.string().nullable(),
|
|
560
|
+
fixedOutboundIp: z.boolean(),
|
|
561
|
+
environments: z.array(environmentWithDomainsSchema),
|
|
562
|
+
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
563
|
+
});
|
|
564
|
+
const domainFailureReasonSchema = z.enum([
|
|
565
|
+
"caa",
|
|
566
|
+
"dns",
|
|
567
|
+
"invalid_domain",
|
|
568
|
+
"other"
|
|
569
|
+
]);
|
|
570
|
+
const projectDomainMappingSchema = z.object({
|
|
571
|
+
pathPrefix: z.string(),
|
|
572
|
+
environment: environmentSchema$1
|
|
573
|
+
});
|
|
574
|
+
z.object({
|
|
575
|
+
name: z.string(),
|
|
576
|
+
createdAt: z.coerce.date(),
|
|
577
|
+
status: z.enum([
|
|
578
|
+
"ongoing",
|
|
579
|
+
"deployed",
|
|
580
|
+
"failed"
|
|
581
|
+
]),
|
|
582
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
583
|
+
environment: environmentSchema$1,
|
|
584
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
585
|
+
});
|
|
586
|
+
const serverFieldsSchema$1 = z.object({
|
|
587
|
+
$schema: z.string(),
|
|
588
|
+
name: z.string(),
|
|
589
|
+
description: z.string(),
|
|
590
|
+
version: z.string().optional(),
|
|
591
|
+
title: z.string().optional(),
|
|
592
|
+
websiteUrl: z.string().optional(),
|
|
593
|
+
icons: z.array(z.object({
|
|
594
|
+
src: z.string(),
|
|
595
|
+
mimeType: z.string().optional(),
|
|
596
|
+
sizes: z.array(z.string()).optional()
|
|
597
|
+
})).optional(),
|
|
598
|
+
remotes: z.array(z.object({
|
|
599
|
+
type: z.string(),
|
|
600
|
+
url: z.string().optional(),
|
|
601
|
+
headers: z.array(z.object({
|
|
602
|
+
name: z.string(),
|
|
603
|
+
description: z.string(),
|
|
604
|
+
isRequired: z.boolean().optional(),
|
|
605
|
+
isSecret: z.boolean().optional()
|
|
606
|
+
})).optional()
|
|
607
|
+
})).optional()
|
|
608
|
+
}).catchall(z.unknown());
|
|
609
|
+
z.object({
|
|
610
|
+
serverFields: serverFieldsSchema$1,
|
|
611
|
+
source: z.enum(["registry", "defaults"])
|
|
612
|
+
});
|
|
613
|
+
/**
|
|
614
|
+
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
615
|
+
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
616
|
+
*
|
|
617
|
+
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
618
|
+
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
619
|
+
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
620
|
+
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
621
|
+
*/
|
|
622
|
+
const clampStringField = (field) => {
|
|
623
|
+
const max = field.maxLength;
|
|
624
|
+
if (max === null) return field;
|
|
625
|
+
const clamped = z.string().overwrite((value) => value.slice(0, max)).max(max);
|
|
626
|
+
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
627
|
+
return field.description ? withMin.describe(field.description) : withMin;
|
|
628
|
+
};
|
|
629
|
+
const toolDefinitionSchema = z.object({
|
|
630
|
+
name: z.string(),
|
|
631
|
+
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
632
|
+
description: z.string().optional(),
|
|
633
|
+
annotations: z.object({
|
|
634
|
+
readOnlyHint: z.boolean().optional(),
|
|
635
|
+
destructiveHint: z.boolean().optional(),
|
|
636
|
+
openWorldHint: z.boolean().optional(),
|
|
637
|
+
idempotentHint: z.boolean().optional()
|
|
638
|
+
}).optional()
|
|
639
|
+
});
|
|
640
|
+
const positiveTestCaseSchema = z.object({
|
|
641
|
+
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
642
|
+
userPrompt: z.string().describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
643
|
+
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
644
|
+
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
645
|
+
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
646
|
+
const screenshotEntrySchema = z.object({
|
|
647
|
+
prompt: z.string(),
|
|
648
|
+
url: z.url()
|
|
649
|
+
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
650
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
651
|
+
/** Accepts either a valid email or URL. */
|
|
652
|
+
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
653
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
654
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
655
|
+
const chatgptCategorySchema = z.enum([
|
|
656
|
+
"BUSINESS",
|
|
657
|
+
"COLLABORATION",
|
|
658
|
+
"DESIGN",
|
|
659
|
+
"DEVELOPER_TOOLS",
|
|
660
|
+
"EDUCATION",
|
|
661
|
+
"ENTERTAINMENT",
|
|
662
|
+
"FINANCE",
|
|
663
|
+
"FOOD",
|
|
664
|
+
"LIFESTYLE",
|
|
665
|
+
"NEWS",
|
|
666
|
+
"PRODUCTIVITY",
|
|
667
|
+
"SHOPPING",
|
|
668
|
+
"TRAVEL"
|
|
669
|
+
]);
|
|
670
|
+
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
671
|
+
const chatgptCountryCodeSchema = z.enum([
|
|
672
|
+
"AD",
|
|
673
|
+
"AE",
|
|
674
|
+
"AF",
|
|
675
|
+
"AG",
|
|
676
|
+
"AL",
|
|
677
|
+
"AM",
|
|
678
|
+
"AO",
|
|
679
|
+
"AR",
|
|
680
|
+
"AT",
|
|
681
|
+
"AU",
|
|
682
|
+
"AW",
|
|
683
|
+
"AX",
|
|
684
|
+
"AZ",
|
|
685
|
+
"BA",
|
|
686
|
+
"BB",
|
|
687
|
+
"BD",
|
|
688
|
+
"BE",
|
|
689
|
+
"BF",
|
|
690
|
+
"BG",
|
|
691
|
+
"BH",
|
|
692
|
+
"BI",
|
|
693
|
+
"BJ",
|
|
694
|
+
"BL",
|
|
695
|
+
"BM",
|
|
696
|
+
"BN",
|
|
697
|
+
"BO",
|
|
698
|
+
"BR",
|
|
699
|
+
"BS",
|
|
700
|
+
"BT",
|
|
701
|
+
"BW",
|
|
702
|
+
"BZ",
|
|
703
|
+
"CA",
|
|
704
|
+
"CD",
|
|
705
|
+
"CF",
|
|
706
|
+
"CG",
|
|
707
|
+
"CH",
|
|
708
|
+
"CI",
|
|
709
|
+
"CL",
|
|
710
|
+
"CM",
|
|
711
|
+
"CO",
|
|
712
|
+
"CR",
|
|
713
|
+
"CV",
|
|
714
|
+
"CY",
|
|
715
|
+
"CZ",
|
|
716
|
+
"DE",
|
|
717
|
+
"DJ",
|
|
718
|
+
"DK",
|
|
719
|
+
"DM",
|
|
720
|
+
"DO",
|
|
721
|
+
"DZ",
|
|
722
|
+
"EC",
|
|
723
|
+
"EE",
|
|
724
|
+
"EG",
|
|
725
|
+
"ER",
|
|
726
|
+
"ES",
|
|
727
|
+
"ET",
|
|
728
|
+
"FI",
|
|
729
|
+
"FJ",
|
|
730
|
+
"FM",
|
|
731
|
+
"FO",
|
|
732
|
+
"FR",
|
|
733
|
+
"GA",
|
|
734
|
+
"GB",
|
|
735
|
+
"GD",
|
|
736
|
+
"GE",
|
|
737
|
+
"GF",
|
|
738
|
+
"GH",
|
|
739
|
+
"GL",
|
|
740
|
+
"GM",
|
|
741
|
+
"GN",
|
|
742
|
+
"GP",
|
|
743
|
+
"GQ",
|
|
744
|
+
"GR",
|
|
745
|
+
"GT",
|
|
746
|
+
"GW",
|
|
747
|
+
"GY",
|
|
748
|
+
"HN",
|
|
749
|
+
"HR",
|
|
750
|
+
"HT",
|
|
751
|
+
"HU",
|
|
752
|
+
"ID",
|
|
753
|
+
"IE",
|
|
754
|
+
"IL",
|
|
755
|
+
"IN",
|
|
756
|
+
"IQ",
|
|
757
|
+
"IS",
|
|
758
|
+
"IT",
|
|
759
|
+
"JM",
|
|
760
|
+
"JO",
|
|
761
|
+
"JP",
|
|
762
|
+
"KE",
|
|
763
|
+
"KG",
|
|
764
|
+
"KH",
|
|
765
|
+
"KI",
|
|
766
|
+
"KM",
|
|
767
|
+
"KN",
|
|
768
|
+
"KR",
|
|
769
|
+
"KW",
|
|
770
|
+
"KY",
|
|
771
|
+
"KZ",
|
|
772
|
+
"LA",
|
|
773
|
+
"LB",
|
|
774
|
+
"LC",
|
|
775
|
+
"LI",
|
|
776
|
+
"LK",
|
|
777
|
+
"LR",
|
|
778
|
+
"LS",
|
|
779
|
+
"LT",
|
|
780
|
+
"LU",
|
|
781
|
+
"LV",
|
|
782
|
+
"LY",
|
|
783
|
+
"MA",
|
|
784
|
+
"MC",
|
|
785
|
+
"MD",
|
|
786
|
+
"ME",
|
|
787
|
+
"MF",
|
|
788
|
+
"MG",
|
|
789
|
+
"MH",
|
|
790
|
+
"MK",
|
|
791
|
+
"ML",
|
|
792
|
+
"MM",
|
|
793
|
+
"MN",
|
|
794
|
+
"MQ",
|
|
795
|
+
"MR",
|
|
796
|
+
"MT",
|
|
797
|
+
"MU",
|
|
798
|
+
"MV",
|
|
799
|
+
"MW",
|
|
800
|
+
"MX",
|
|
801
|
+
"MY",
|
|
802
|
+
"MZ",
|
|
803
|
+
"NA",
|
|
804
|
+
"NC",
|
|
805
|
+
"NE",
|
|
806
|
+
"NG",
|
|
807
|
+
"NI",
|
|
808
|
+
"NL",
|
|
809
|
+
"NO",
|
|
810
|
+
"NP",
|
|
811
|
+
"NR",
|
|
812
|
+
"NZ",
|
|
813
|
+
"OM",
|
|
814
|
+
"PA",
|
|
815
|
+
"PE",
|
|
816
|
+
"PF",
|
|
817
|
+
"PG",
|
|
818
|
+
"PH",
|
|
819
|
+
"PK",
|
|
820
|
+
"PL",
|
|
821
|
+
"PM",
|
|
822
|
+
"PS",
|
|
823
|
+
"PT",
|
|
824
|
+
"PW",
|
|
825
|
+
"PY",
|
|
826
|
+
"QA",
|
|
827
|
+
"RE",
|
|
828
|
+
"RO",
|
|
829
|
+
"RS",
|
|
830
|
+
"RW",
|
|
831
|
+
"SA",
|
|
832
|
+
"SB",
|
|
833
|
+
"SC",
|
|
834
|
+
"SD",
|
|
835
|
+
"SE",
|
|
836
|
+
"SG",
|
|
837
|
+
"SH",
|
|
838
|
+
"SI",
|
|
839
|
+
"SJ",
|
|
840
|
+
"SK",
|
|
841
|
+
"SL",
|
|
842
|
+
"SM",
|
|
843
|
+
"SN",
|
|
844
|
+
"SO",
|
|
845
|
+
"SR",
|
|
846
|
+
"SS",
|
|
847
|
+
"ST",
|
|
848
|
+
"SV",
|
|
849
|
+
"SZ",
|
|
850
|
+
"TD",
|
|
851
|
+
"TF",
|
|
852
|
+
"TG",
|
|
853
|
+
"TH",
|
|
854
|
+
"TJ",
|
|
855
|
+
"TL",
|
|
856
|
+
"TM",
|
|
857
|
+
"TN",
|
|
858
|
+
"TO",
|
|
859
|
+
"TR",
|
|
860
|
+
"TT",
|
|
861
|
+
"TV",
|
|
862
|
+
"TW",
|
|
863
|
+
"TZ",
|
|
864
|
+
"UA",
|
|
865
|
+
"UG",
|
|
866
|
+
"US",
|
|
867
|
+
"UY",
|
|
868
|
+
"UZ",
|
|
869
|
+
"VA",
|
|
870
|
+
"VC",
|
|
871
|
+
"VN",
|
|
872
|
+
"VU",
|
|
873
|
+
"WF",
|
|
874
|
+
"WS",
|
|
875
|
+
"YE",
|
|
876
|
+
"YT",
|
|
877
|
+
"ZA",
|
|
878
|
+
"ZM",
|
|
879
|
+
"ZW"
|
|
880
|
+
]);
|
|
881
|
+
const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
|
|
882
|
+
z.object({ mode: z.literal("all") }),
|
|
883
|
+
z.object({
|
|
884
|
+
mode: z.literal("allow"),
|
|
885
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
886
|
+
}),
|
|
887
|
+
z.object({
|
|
888
|
+
mode: z.literal("block"),
|
|
889
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
890
|
+
})
|
|
891
|
+
]);
|
|
892
|
+
const chatgptTranslationLocaleSchema = z.enum([
|
|
893
|
+
"am",
|
|
894
|
+
"ar",
|
|
895
|
+
"bg-BG",
|
|
896
|
+
"bn-BD",
|
|
897
|
+
"bs-BA",
|
|
898
|
+
"ca-ES",
|
|
899
|
+
"cs-CZ",
|
|
900
|
+
"da-DK",
|
|
901
|
+
"de-DE",
|
|
902
|
+
"el-GR",
|
|
903
|
+
"es-419",
|
|
904
|
+
"es-ES",
|
|
905
|
+
"et-EE",
|
|
906
|
+
"fi-FI",
|
|
907
|
+
"fr-CA",
|
|
908
|
+
"fr-FR",
|
|
909
|
+
"gu-IN",
|
|
910
|
+
"hi-IN",
|
|
911
|
+
"hr-HR",
|
|
912
|
+
"hu-HU",
|
|
913
|
+
"hy-AM",
|
|
914
|
+
"id-ID",
|
|
915
|
+
"is-IS",
|
|
916
|
+
"it-IT",
|
|
917
|
+
"ja-JP",
|
|
918
|
+
"ka-GE",
|
|
919
|
+
"kk",
|
|
920
|
+
"kn-IN",
|
|
921
|
+
"ko-KR",
|
|
922
|
+
"lt",
|
|
923
|
+
"lv-LV",
|
|
924
|
+
"mk-MK",
|
|
925
|
+
"ml",
|
|
926
|
+
"mn",
|
|
927
|
+
"mr-IN",
|
|
928
|
+
"ms-MY",
|
|
929
|
+
"my-MM",
|
|
930
|
+
"nb-NO",
|
|
931
|
+
"nl-NL",
|
|
932
|
+
"pa",
|
|
933
|
+
"pl-PL",
|
|
934
|
+
"pt-BR",
|
|
935
|
+
"pt-PT",
|
|
936
|
+
"ro-RO",
|
|
937
|
+
"ru-RU",
|
|
938
|
+
"sk-SK",
|
|
939
|
+
"sl-SI",
|
|
940
|
+
"so-SO",
|
|
941
|
+
"sq-AL",
|
|
942
|
+
"sr-RS",
|
|
943
|
+
"sv-SE",
|
|
944
|
+
"sw-TZ",
|
|
945
|
+
"ta-IN",
|
|
946
|
+
"te-IN",
|
|
947
|
+
"th-TH",
|
|
948
|
+
"tl",
|
|
949
|
+
"tr-TR",
|
|
950
|
+
"uk-UA",
|
|
951
|
+
"ur",
|
|
952
|
+
"vi-VN",
|
|
953
|
+
"zh-CN",
|
|
954
|
+
"zh-HK",
|
|
955
|
+
"zh-TW"
|
|
956
|
+
]);
|
|
957
|
+
const negativeTestCaseSchema = z.object({
|
|
958
|
+
scenario: z.string(),
|
|
959
|
+
userPrompt: z.string()
|
|
960
|
+
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
961
|
+
const chatgptToolJustificationSchema = z.object({
|
|
962
|
+
toolName: z.string(),
|
|
963
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
964
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
965
|
+
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
966
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
967
|
+
/**
|
|
968
|
+
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
969
|
+
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
970
|
+
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
971
|
+
*/
|
|
972
|
+
const chatgptTaglineSchema = z.string().max(30);
|
|
973
|
+
const chatgptDescriptionSchema = z.string();
|
|
974
|
+
const chatgptTranslationSchema = z.object({
|
|
975
|
+
locale: chatgptTranslationLocaleSchema,
|
|
976
|
+
tagline: chatgptTaglineSchema,
|
|
977
|
+
description: chatgptDescriptionSchema
|
|
978
|
+
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
979
|
+
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
980
|
+
/**
|
|
981
|
+
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
982
|
+
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
983
|
+
*/
|
|
984
|
+
const chatgptSubmissionFormDataSchema = z.object({
|
|
985
|
+
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
986
|
+
logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
|
|
987
|
+
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
988
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
989
|
+
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the app does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
|
|
990
|
+
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
991
|
+
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
992
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
993
|
+
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
994
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
995
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
996
|
+
demoRecordingUrl: urlField.describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
997
|
+
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My app links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the app does not offer digital goods."),
|
|
998
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
999
|
+
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
1000
|
+
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1001
|
+
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
|
|
1002
|
+
testCases: z.array(positiveTestCaseSchema).describe("At least 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."),
|
|
1003
|
+
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
1004
|
+
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
1005
|
+
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1006
|
+
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
1007
|
+
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
1008
|
+
});
|
|
1009
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1010
|
+
tagline: z.string().optional(),
|
|
1011
|
+
companyUrl: z.string().optional(),
|
|
1012
|
+
supportChannel: z.string().optional(),
|
|
1013
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1014
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1015
|
+
demoRecordingUrl: z.string().optional(),
|
|
1016
|
+
serverUrl: z.string().optional(),
|
|
1017
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1018
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1019
|
+
});
|
|
1020
|
+
chatgptSubmissionFormDataSchema.pick({
|
|
1021
|
+
appName: true,
|
|
1022
|
+
developerName: true,
|
|
1023
|
+
serverUrl: true,
|
|
1024
|
+
tools: true,
|
|
1025
|
+
authentication: true
|
|
1026
|
+
});
|
|
1027
|
+
chatgptSubmissionFormDataSchema.pick({
|
|
1028
|
+
tagline: true,
|
|
1029
|
+
description: true,
|
|
1030
|
+
category: true,
|
|
1031
|
+
testCases: true,
|
|
1032
|
+
negativeTestCases: true,
|
|
1033
|
+
toolJustifications: true
|
|
1034
|
+
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
1035
|
+
const claudeCategorySchema = z.enum([
|
|
1036
|
+
"Productivity",
|
|
1037
|
+
"Communication",
|
|
1038
|
+
"Data & Analytics",
|
|
1039
|
+
"Development tools",
|
|
1040
|
+
"Financial Services",
|
|
1041
|
+
"Consumer Health",
|
|
1042
|
+
"Health & Life Sciences",
|
|
1043
|
+
"Media & Entertainment",
|
|
1044
|
+
"Commerce & Shopping",
|
|
1045
|
+
"Legal",
|
|
1046
|
+
"Sales and marketing",
|
|
1047
|
+
"Creative",
|
|
1048
|
+
"Nonprofit",
|
|
1049
|
+
"Education",
|
|
1050
|
+
"Other"
|
|
1051
|
+
]);
|
|
1052
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
1053
|
+
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
1054
|
+
"read_only",
|
|
1055
|
+
"write_only",
|
|
1056
|
+
"read_write"
|
|
1057
|
+
]);
|
|
1058
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1059
|
+
"oauth_dcr",
|
|
1060
|
+
"oauth_cimd",
|
|
1061
|
+
"oauth_anthropic_creds",
|
|
1062
|
+
"custom_connection",
|
|
1063
|
+
"none"
|
|
1064
|
+
]);
|
|
1065
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1066
|
+
"first_party",
|
|
1067
|
+
"proxied",
|
|
1068
|
+
"third_party"
|
|
1069
|
+
]);
|
|
1070
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1071
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1072
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1073
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1074
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1075
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1076
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1077
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1078
|
+
"Public documentation for this connector will be live by the publish date."
|
|
1079
|
+
]);
|
|
1080
|
+
/**
|
|
1081
|
+
* Field order mirrors the claude.ai directory submission wizard
|
|
1082
|
+
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1083
|
+
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1084
|
+
*/
|
|
1085
|
+
const claudeSubmissionFormDataSchema = z.object({
|
|
1086
|
+
serverUrl: z.url().describe(`The full https:// URL where your MCP server is hosted and reachable. In the claude.ai wizard this is read live
|
|
1087
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1088
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1089
|
+
name: z.string().max(100).describe(`The public display name for your connector as it appears in the directory. Use your brand/product name. You must
|
|
1090
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1091
|
+
slug: z.string().max(50).regex(/^[a-z0-9-]+$/).describe(`URL-safe identifier for your connector's directory page. Lowercase letters, numbers, and hyphens only.
|
|
1092
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1093
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1094
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1095
|
+
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
|
|
1096
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1097
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1098
|
+
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
|
|
1099
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1100
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1101
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1102
|
+
by your publish date.`),
|
|
1103
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1104
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1105
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1106
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1107
|
+
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
|
|
1108
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1109
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1110
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1111
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1112
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1113
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1114
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1115
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1116
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1117
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1118
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1119
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1120
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1121
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1122
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1123
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1124
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1125
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1126
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1127
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1128
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1129
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1130
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1131
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1132
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1133
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1134
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1135
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1136
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1137
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1138
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1139
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1140
|
+
fully populated account.`),
|
|
1141
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1142
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1143
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1144
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1145
|
+
});
|
|
1146
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1147
|
+
serverUrl: z.string().optional(),
|
|
1148
|
+
name: z.string().optional(),
|
|
1149
|
+
slug: z.string().optional(),
|
|
1150
|
+
oneLiner: z.string().optional(),
|
|
1151
|
+
description: z.string().optional(),
|
|
1152
|
+
iconUrl: z.string().optional(),
|
|
1153
|
+
documentation: z.string().optional(),
|
|
1154
|
+
support: z.string().optional(),
|
|
1155
|
+
privacyPolicy: z.string().optional(),
|
|
1156
|
+
companyWebsite: z.string().optional(),
|
|
1157
|
+
primaryContactEmail: z.string().optional(),
|
|
1158
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1159
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1160
|
+
});
|
|
1161
|
+
claudeSubmissionFormDataSchema.pick({
|
|
1162
|
+
serverUrl: true,
|
|
1163
|
+
name: true,
|
|
1164
|
+
slug: true,
|
|
1165
|
+
companyName: true,
|
|
1166
|
+
primaryContactEmail: true,
|
|
1167
|
+
primaryContactName: true,
|
|
1168
|
+
readWriteCapabilities: true,
|
|
1169
|
+
authentication: true,
|
|
1170
|
+
apiOwnership: true,
|
|
1171
|
+
personalHealthData: true
|
|
1172
|
+
}).extend({
|
|
1173
|
+
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1174
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1175
|
+
});
|
|
1176
|
+
/**
|
|
1177
|
+
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1178
|
+
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1179
|
+
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1180
|
+
* colocated with the Claude contract.
|
|
1181
|
+
*/
|
|
1182
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1183
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1184
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1185
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1186
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1187
|
+
});
|
|
1188
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1189
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1190
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1191
|
+
});
|
|
1192
|
+
const submissionMetaFieldsSchema = z.object({
|
|
1193
|
+
id: z.string(),
|
|
1194
|
+
environmentId: z.string(),
|
|
1195
|
+
auditId: z.string().nullable(),
|
|
1196
|
+
createdAt: z.coerce.date(),
|
|
1197
|
+
updatedAt: z.coerce.date()
|
|
1198
|
+
});
|
|
1199
|
+
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1200
|
+
platform: z.literal("claudeai"),
|
|
1201
|
+
formData: claudeSubmissionDraftSchema
|
|
1202
|
+
});
|
|
1203
|
+
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1204
|
+
platform: z.literal("chatgpt"),
|
|
1205
|
+
formData: chatgptSubmissionDraftSchema
|
|
1206
|
+
});
|
|
1207
|
+
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1208
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1209
|
+
const subscriptionPlanSchema = z.enum([
|
|
1210
|
+
"pro",
|
|
1211
|
+
"business",
|
|
1212
|
+
"enterprise"
|
|
1213
|
+
]);
|
|
1214
|
+
z.object({ plan: subscriptionPlanSchema.nullable() });
|
|
1215
|
+
const customerCreditsSchema = z.object({
|
|
1216
|
+
balanceInCents: z.number(),
|
|
1217
|
+
expiresAt: z.number().nullable(),
|
|
1218
|
+
currency: z.string()
|
|
1219
|
+
});
|
|
1220
|
+
const customerUsageSchema = z.object({
|
|
1221
|
+
amountInCents: z.number(),
|
|
1222
|
+
currency: z.string(),
|
|
1223
|
+
periodEnd: z.number()
|
|
1224
|
+
});
|
|
1225
|
+
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1226
|
+
z.object({
|
|
1227
|
+
customerCredits: customerCreditsSchema.nullable(),
|
|
1228
|
+
customerUsage: customerUsageSchema.nullable(),
|
|
1229
|
+
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1230
|
+
});
|
|
1231
|
+
//#endregion
|
|
1232
|
+
//#region src/auth-scope.ts
|
|
1233
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1234
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1235
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1236
|
+
const AUTH_SCOPE_USER = "user";
|
|
75
1237
|
//#endregion
|
|
76
1238
|
//#region src/schemas.ts
|
|
77
1239
|
const RESERVED_KEYS = [
|
|
@@ -108,7 +1270,10 @@ const RESERVED_KEYS = [
|
|
|
108
1270
|
"BUILD_ARG_START_COMMAND",
|
|
109
1271
|
"ALPIC_HOST",
|
|
110
1272
|
"ALPIC_CUSTOM_DOMAINS",
|
|
111
|
-
"
|
|
1273
|
+
"ALPIC_INTENT_META_KEY",
|
|
1274
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1275
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1276
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
112
1277
|
];
|
|
113
1278
|
const environmentVariableSchema = z.object({
|
|
114
1279
|
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"),
|
|
@@ -126,17 +1291,6 @@ const buildSettingsSchema = z.object({
|
|
|
126
1291
|
buildOutputDir: z.string().optional(),
|
|
127
1292
|
startCommand: z.string().optional()
|
|
128
1293
|
});
|
|
129
|
-
const runtimeSchema = z.enum([
|
|
130
|
-
"python3.13",
|
|
131
|
-
"python3.14",
|
|
132
|
-
"node22",
|
|
133
|
-
"node24"
|
|
134
|
-
]);
|
|
135
|
-
const transportSchema = z.enum([
|
|
136
|
-
"stdio",
|
|
137
|
-
"sse",
|
|
138
|
-
"streamablehttp"
|
|
139
|
-
]);
|
|
140
1294
|
const playgroundHeaderSchema = z.object({
|
|
141
1295
|
name: z.string().min(1).max(100),
|
|
142
1296
|
description: z.string().max(200),
|
|
@@ -223,7 +1377,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
223
1377
|
id: z.string(),
|
|
224
1378
|
name: z.string(),
|
|
225
1379
|
sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
|
|
226
|
-
urls: z.array(z.
|
|
1380
|
+
urls: z.array(z.url()).describe("The URLs of the MCP server"),
|
|
227
1381
|
createdAt: z.coerce.date(),
|
|
228
1382
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
229
1383
|
}));
|
|
@@ -239,7 +1393,7 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
239
1393
|
name: z.string(),
|
|
240
1394
|
sourceBranch: z.string().nullable(),
|
|
241
1395
|
mcpServerUrl: z.string(),
|
|
242
|
-
domains: z.array(z.
|
|
1396
|
+
domains: z.array(z.hostname()),
|
|
243
1397
|
createdAt: z.coerce.date(),
|
|
244
1398
|
projectId: z.string()
|
|
245
1399
|
}));
|
|
@@ -299,6 +1453,9 @@ const listProjectsContractV1 = oc.route({
|
|
|
299
1453
|
description: "List all projects for a team",
|
|
300
1454
|
tags: ["projects"],
|
|
301
1455
|
successDescription: "The list of projects"
|
|
1456
|
+
}).errors({
|
|
1457
|
+
NOT_FOUND: {},
|
|
1458
|
+
BAD_REQUEST: {}
|
|
302
1459
|
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
303
1460
|
const createProjectContractV1 = oc.route({
|
|
304
1461
|
path: "/v1/projects",
|
|
@@ -309,7 +1466,8 @@ const createProjectContractV1 = oc.route({
|
|
|
309
1466
|
successDescription: "The project has been created successfully"
|
|
310
1467
|
}).errors({
|
|
311
1468
|
NOT_FOUND: {},
|
|
312
|
-
BAD_REQUEST: {}
|
|
1469
|
+
BAD_REQUEST: {},
|
|
1470
|
+
FORBIDDEN: {}
|
|
313
1471
|
}).input(z.object({
|
|
314
1472
|
teamId: z.string().optional(),
|
|
315
1473
|
name: z.string().trim().min(1).max(100),
|
|
@@ -394,7 +1552,10 @@ const deleteEnvironmentVariableContractV1 = oc.route({
|
|
|
394
1552
|
description: "Delete an environment variable by ID",
|
|
395
1553
|
tags: ["environments"],
|
|
396
1554
|
successDescription: "The environment variable has been deleted successfully"
|
|
397
|
-
}).errors({
|
|
1555
|
+
}).errors({
|
|
1556
|
+
NOT_FOUND: {},
|
|
1557
|
+
BAD_REQUEST: {}
|
|
1558
|
+
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
398
1559
|
const deleteProjectContractV1 = oc.route({
|
|
399
1560
|
path: "/v1/projects/{projectId}",
|
|
400
1561
|
method: "DELETE",
|
|
@@ -412,7 +1573,8 @@ const updateProjectContractV1 = oc.route({
|
|
|
412
1573
|
successDescription: "The project has been updated successfully"
|
|
413
1574
|
}).errors({
|
|
414
1575
|
NOT_FOUND: {},
|
|
415
|
-
BAD_REQUEST: {}
|
|
1576
|
+
BAD_REQUEST: {},
|
|
1577
|
+
FORBIDDEN: {}
|
|
416
1578
|
}).input(z.object({
|
|
417
1579
|
projectId: z.string().describe("The ID of the project"),
|
|
418
1580
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
@@ -427,10 +1589,12 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
427
1589
|
successDescription: "The environment has been deployed successfully"
|
|
428
1590
|
}).errors({
|
|
429
1591
|
NOT_FOUND: {},
|
|
430
|
-
BAD_REQUEST: {}
|
|
1592
|
+
BAD_REQUEST: {},
|
|
1593
|
+
CONFLICT: {}
|
|
431
1594
|
}).input(z.object({
|
|
432
1595
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
433
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1596
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1597
|
+
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.")
|
|
434
1598
|
})).output(deploymentSchema);
|
|
435
1599
|
const uploadDeploymentArtifactContractV1 = oc.route({
|
|
436
1600
|
path: "/v1/deployments/upload",
|
|
@@ -439,6 +1603,9 @@ const uploadDeploymentArtifactContractV1 = oc.route({
|
|
|
439
1603
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
440
1604
|
tags: ["deployments"],
|
|
441
1605
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1606
|
+
}).errors({
|
|
1607
|
+
NOT_FOUND: {},
|
|
1608
|
+
BAD_REQUEST: {}
|
|
442
1609
|
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
443
1610
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
444
1611
|
token: z.string().describe("Token to identify the source archive"),
|
|
@@ -464,6 +1631,21 @@ const getDeploymentContractV1 = oc.route({
|
|
|
464
1631
|
tags: ["deployments"],
|
|
465
1632
|
successDescription: "The deployment details"
|
|
466
1633
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1634
|
+
const logEntrySchema = z.object({
|
|
1635
|
+
timestamp: z.coerce.date(),
|
|
1636
|
+
type: z.enum([
|
|
1637
|
+
"START",
|
|
1638
|
+
"END",
|
|
1639
|
+
"INFO",
|
|
1640
|
+
"ERROR",
|
|
1641
|
+
"WARNING",
|
|
1642
|
+
"DEBUG"
|
|
1643
|
+
]),
|
|
1644
|
+
requestId: z.string(),
|
|
1645
|
+
content: z.string().optional(),
|
|
1646
|
+
method: z.string().optional(),
|
|
1647
|
+
durationInMs: z.number().optional()
|
|
1648
|
+
});
|
|
467
1649
|
const getLogsContractV1 = oc.route({
|
|
468
1650
|
path: "/v1/environments/{environmentId}/logs",
|
|
469
1651
|
method: "GET",
|
|
@@ -488,21 +1670,7 @@ const getLogsContractV1 = oc.route({
|
|
|
488
1670
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
489
1671
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
490
1672
|
})).output(z.object({
|
|
491
|
-
logs: z.array(
|
|
492
|
-
timestamp: z.coerce.date(),
|
|
493
|
-
type: z.enum([
|
|
494
|
-
"START",
|
|
495
|
-
"END",
|
|
496
|
-
"INFO",
|
|
497
|
-
"ERROR",
|
|
498
|
-
"WARNING",
|
|
499
|
-
"DEBUG"
|
|
500
|
-
]),
|
|
501
|
-
requestId: z.string(),
|
|
502
|
-
content: z.string().optional(),
|
|
503
|
-
method: z.string().optional(),
|
|
504
|
-
durationInMs: z.number().optional()
|
|
505
|
-
})),
|
|
1673
|
+
logs: z.array(logEntrySchema),
|
|
506
1674
|
nextToken: z.string().nullable()
|
|
507
1675
|
}));
|
|
508
1676
|
const getLatestLogsContractV1 = oc.route({
|
|
@@ -525,21 +1693,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
525
1693
|
"DEBUG"
|
|
526
1694
|
])).optional().describe("Filter by log level"),
|
|
527
1695
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
528
|
-
})).output(z.object({ logs: z.array(
|
|
529
|
-
timestamp: z.coerce.date(),
|
|
530
|
-
type: z.enum([
|
|
531
|
-
"START",
|
|
532
|
-
"END",
|
|
533
|
-
"INFO",
|
|
534
|
-
"ERROR",
|
|
535
|
-
"WARNING",
|
|
536
|
-
"DEBUG"
|
|
537
|
-
]),
|
|
538
|
-
requestId: z.string(),
|
|
539
|
-
content: z.string().optional(),
|
|
540
|
-
method: z.string().optional(),
|
|
541
|
-
durationInMs: z.number().optional()
|
|
542
|
-
})) }));
|
|
1696
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
543
1697
|
const getDeploymentLogsContractV1 = oc.route({
|
|
544
1698
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
545
1699
|
method: "GET",
|
|
@@ -612,7 +1766,7 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
612
1766
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
613
1767
|
tags: ["tunnels"],
|
|
614
1768
|
successDescription: "The tunnel ticket"
|
|
615
|
-
}).output(z.object({
|
|
1769
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
616
1770
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
617
1771
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
618
1772
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
@@ -688,7 +1842,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
688
1842
|
name: z.string().min(1).max(100).optional(),
|
|
689
1843
|
description: z.string().min(1).max(500).optional(),
|
|
690
1844
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
691
|
-
examplePrompts: z.array(playgroundExamplePromptSchema).max(
|
|
1845
|
+
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
692
1846
|
})).output(playgroundOutputSchema);
|
|
693
1847
|
const createBeaconContractV1 = oc.route({
|
|
694
1848
|
path: "/v1/beacon/audits",
|
|
@@ -699,7 +1853,8 @@ const createBeaconContractV1 = oc.route({
|
|
|
699
1853
|
successDescription: "The audit has been created"
|
|
700
1854
|
}).errors({
|
|
701
1855
|
NOT_FOUND: {},
|
|
702
|
-
BAD_REQUEST: {}
|
|
1856
|
+
BAD_REQUEST: {},
|
|
1857
|
+
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
703
1858
|
}).input(z.object({
|
|
704
1859
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
705
1860
|
teamId: z.string().optional().describe("The team ID to associate the audit with"),
|
|
@@ -765,4 +1920,4 @@ const contract = {
|
|
|
765
1920
|
}
|
|
766
1921
|
};
|
|
767
1922
|
//#endregion
|
|
768
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
1923
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|