@alpic-ai/api 0.0.0-staging.ffd67d5 → 0.0.0-staging.g0170168
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 +6466 -258
- package/dist/index.mjs +2012 -164
- package/package.json +27 -8
package/dist/index.mjs
CHANGED
|
@@ -1,72 +1,196 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import * as z$1 from "zod/v4";
|
|
1
3
|
import { oc } from "@orpc/contract";
|
|
2
4
|
import ms from "ms";
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
"
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
"ALPIC_CUSTOM_DOMAINS"
|
|
39
|
-
];
|
|
40
|
-
const environmentVariableSchema = z.object({
|
|
41
|
-
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"),
|
|
42
|
-
value: z.string().min(1, "Value is required"),
|
|
43
|
-
isSecret: z.boolean().default(false)
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.0_supports-color@7.2.0_zod@4.5.4/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
|
+
/**
|
|
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()
|
|
44
40
|
});
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
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()
|
|
51
64
|
});
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
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
|
|
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
|
+
"cato",
|
|
183
|
+
"cloudflare",
|
|
184
|
+
"fastly"
|
|
185
|
+
];
|
|
186
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
187
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
188
|
+
const auditStatusSchema = z.enum([
|
|
64
189
|
"pending",
|
|
65
190
|
"partial",
|
|
66
191
|
"completed",
|
|
67
192
|
"failed"
|
|
68
193
|
]);
|
|
69
|
-
const platformSchema = z.enum(["chatgpt", "claudeai"]);
|
|
70
194
|
const checkSeveritySchema = z.enum([
|
|
71
195
|
"error",
|
|
72
196
|
"warning",
|
|
@@ -86,6 +210,8 @@ const checkDetailSchema = z.object({
|
|
|
86
210
|
});
|
|
87
211
|
const checkResultSchema = z.object({
|
|
88
212
|
checkId: z.string(),
|
|
213
|
+
checkName: z.string(),
|
|
214
|
+
description: z.string(),
|
|
89
215
|
status: z.enum([
|
|
90
216
|
"pass",
|
|
91
217
|
"fail",
|
|
@@ -117,12 +243,1436 @@ const auditReportSchema = z.object({
|
|
|
117
243
|
widgetScreenshotKeys: z.object({
|
|
118
244
|
chatgpt: z.string().optional(),
|
|
119
245
|
claudeai: z.string().optional()
|
|
120
|
-
})
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
246
|
+
})
|
|
247
|
+
});
|
|
248
|
+
const widgetScreenshotSchema = z.object({ url: z.string() });
|
|
249
|
+
const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreenshots: z.object({
|
|
250
|
+
chatgpt: widgetScreenshotSchema.optional(),
|
|
251
|
+
claudeai: widgetScreenshotSchema.optional()
|
|
252
|
+
}) });
|
|
253
|
+
z.object({
|
|
254
|
+
id: z.string(),
|
|
255
|
+
environmentId: z.string(),
|
|
256
|
+
clientId: z.string(),
|
|
257
|
+
clientSecret: z.string(),
|
|
258
|
+
clientScopes: z.array(z.string())
|
|
259
|
+
});
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"admin_adjustment"
|
|
266
|
+
]);
|
|
267
|
+
z.enum(["playground"]);
|
|
268
|
+
z.number().int().min(500);
|
|
269
|
+
const creditActivityEntrySchema = z.object({
|
|
270
|
+
reason: creditEntryReasonSchema,
|
|
271
|
+
day: z.number(),
|
|
272
|
+
amountInNanoUSD: z.number(),
|
|
273
|
+
messageCount: z.number().nullable()
|
|
274
|
+
});
|
|
275
|
+
z.object({
|
|
276
|
+
balanceInNanoUSD: z.number(),
|
|
277
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
278
|
+
});
|
|
279
|
+
const deploymentStatusSchema$1 = z.enum([
|
|
280
|
+
"ongoing",
|
|
281
|
+
"deployed",
|
|
282
|
+
"failed",
|
|
283
|
+
"canceled"
|
|
284
|
+
]);
|
|
285
|
+
z.object({
|
|
286
|
+
timestamp: z.coerce.date().optional(),
|
|
287
|
+
content: z.string().optional()
|
|
288
|
+
});
|
|
289
|
+
const deploymentSummarySchema = z.object({
|
|
290
|
+
id: z.string(),
|
|
291
|
+
status: deploymentStatusSchema$1,
|
|
292
|
+
sourceBucket: z.string().nullable(),
|
|
293
|
+
sourceObjectKey: z.string().nullable(),
|
|
294
|
+
sourceRef: z.string().nullable(),
|
|
295
|
+
sourceCommitId: z.string().nullable(),
|
|
296
|
+
sourceCommitMessage: z.string().nullable(),
|
|
297
|
+
environmentId: z.string(),
|
|
298
|
+
authorUsername: z.string().nullable(),
|
|
299
|
+
authorAvatarUrl: z.string().nullable(),
|
|
300
|
+
startedAt: z.coerce.date().nullable(),
|
|
301
|
+
completedAt: z.coerce.date().nullable(),
|
|
302
|
+
isCurrent: z.boolean().optional(),
|
|
303
|
+
createdAt: z.coerce.date(),
|
|
304
|
+
updatedAt: z.coerce.date()
|
|
305
|
+
});
|
|
306
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
307
|
+
const publicEnvironmentSchema = z.object({
|
|
308
|
+
allowsAnonymous: z.literal(true),
|
|
309
|
+
oAuthMetadata: z.strictObject({})
|
|
310
|
+
});
|
|
311
|
+
/** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
|
|
312
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
313
|
+
allowsAnonymous: z.boolean(),
|
|
314
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
315
|
+
scope: z.string().optional()
|
|
316
|
+
});
|
|
317
|
+
/** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
|
|
318
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
319
|
+
allowsAnonymous: z.boolean(),
|
|
320
|
+
oAuthMetadata: z.object({
|
|
321
|
+
externalAuthorizationServerUrl: z.url(),
|
|
322
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
323
|
+
}),
|
|
324
|
+
scope: z.string().optional()
|
|
325
|
+
});
|
|
326
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
327
|
+
const standaloneEnvironmentSchema = z.object({
|
|
328
|
+
allowsAnonymous: z.boolean(),
|
|
329
|
+
oAuthMetadata: z.object({
|
|
330
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
331
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
332
|
+
}),
|
|
333
|
+
scope: z.string().optional()
|
|
334
|
+
});
|
|
335
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
336
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
337
|
+
allowsAnonymous: z.literal(false),
|
|
338
|
+
oAuthMetadata: z.strictObject({}),
|
|
339
|
+
scope: z.string().optional()
|
|
340
|
+
});
|
|
341
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
342
|
+
isPublic: z.literal(true),
|
|
343
|
+
oAuthMetadata: z.undefined().optional()
|
|
344
|
+
});
|
|
345
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
346
|
+
isPublic: z.literal(false),
|
|
347
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
348
|
+
scope: z.string().optional()
|
|
349
|
+
});
|
|
350
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
351
|
+
isPublic: z.literal(false),
|
|
352
|
+
oAuthMetadata: z.object({
|
|
353
|
+
externalAuthorizationServerUrl: z.url(),
|
|
354
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
355
|
+
}),
|
|
356
|
+
scope: z.string().optional()
|
|
357
|
+
});
|
|
358
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
359
|
+
isPublic: z.literal(false),
|
|
360
|
+
oAuthMetadata: z.object({
|
|
361
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
362
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
363
|
+
}),
|
|
364
|
+
scope: z.string().optional()
|
|
365
|
+
});
|
|
366
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
367
|
+
isPublic: z.literal(false),
|
|
368
|
+
oAuthMetadata: z.strictObject({}),
|
|
369
|
+
scope: z.string().optional()
|
|
370
|
+
});
|
|
371
|
+
z.union([
|
|
372
|
+
publicEnvironmentSchema,
|
|
373
|
+
externalResourceMetadataEnvironmentSchema,
|
|
374
|
+
externalAuthorizationServerEnvironmentSchema,
|
|
375
|
+
standaloneEnvironmentSchema,
|
|
376
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
377
|
+
legacyPublicEnvironmentSchema,
|
|
378
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
379
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
380
|
+
legacyStandaloneEnvironmentSchema,
|
|
381
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
382
|
+
]);
|
|
383
|
+
const playgroundModelSchema = z.enum([
|
|
384
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
385
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
386
|
+
"openai.gpt-5.4",
|
|
387
|
+
"openai.gpt-5.5"
|
|
388
|
+
]);
|
|
389
|
+
const environmentDomainSchema = z.object({
|
|
390
|
+
name: z.string(),
|
|
391
|
+
status: z.enum([
|
|
392
|
+
"ongoing",
|
|
393
|
+
"deployed",
|
|
394
|
+
"failed"
|
|
395
|
+
]),
|
|
396
|
+
createdAt: z.coerce.date(),
|
|
397
|
+
updatedAt: z.coerce.date()
|
|
398
|
+
});
|
|
399
|
+
const environmentSchema$1 = z.object({
|
|
400
|
+
id: z.string(),
|
|
401
|
+
name: z.string(),
|
|
402
|
+
sourceBranch: z.string().nullable(),
|
|
403
|
+
mcpServerUrl: z.string(),
|
|
404
|
+
activeDeployment: deploymentSummarySchema.optional(),
|
|
405
|
+
latestDeployment: deploymentSummarySchema.optional(),
|
|
406
|
+
openaiAppsChallenge: z.string().nullable().optional(),
|
|
407
|
+
isPlaygroundEnabled: z.boolean(),
|
|
408
|
+
playgroundModel: playgroundModelSchema,
|
|
409
|
+
isIpWhitelistEnabled: z.boolean(),
|
|
410
|
+
ipAllowlist: z.array(z.string()).nullable(),
|
|
411
|
+
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
412
|
+
projectId: z.string(),
|
|
413
|
+
createdAt: z.coerce.date(),
|
|
414
|
+
updatedAt: z.coerce.date()
|
|
415
|
+
});
|
|
416
|
+
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
417
|
+
z.object({
|
|
418
|
+
sessionReplayEnabled: z.boolean(),
|
|
419
|
+
collectRequestPayload: z.boolean(),
|
|
420
|
+
collectResponsePayload: z.boolean(),
|
|
421
|
+
collectErrorMessage: z.boolean(),
|
|
422
|
+
collectUserData: z.boolean(),
|
|
423
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
424
|
+
});
|
|
425
|
+
const feedbackSchema = z.object({
|
|
426
|
+
id: z.string(),
|
|
427
|
+
createdAt: z.coerce.date(),
|
|
428
|
+
environmentId: z.string(),
|
|
429
|
+
content: z.string(),
|
|
430
|
+
source: z.enum(["model", "user"]),
|
|
431
|
+
clientName: z.string().nullable()
|
|
432
|
+
});
|
|
433
|
+
z.object({
|
|
434
|
+
content: z.string(),
|
|
435
|
+
source: z.enum(["model", "user"])
|
|
436
|
+
});
|
|
437
|
+
const intentCategoryColorSchema = z.enum([
|
|
438
|
+
"red",
|
|
439
|
+
"orange",
|
|
440
|
+
"yellow",
|
|
441
|
+
"green",
|
|
442
|
+
"blue",
|
|
443
|
+
"purple",
|
|
444
|
+
"pink",
|
|
445
|
+
"gray"
|
|
446
|
+
]);
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
448
|
+
const intentCategorySchema = z.object({
|
|
449
|
+
id: z.string(),
|
|
450
|
+
createdAt: z.coerce.date(),
|
|
451
|
+
environmentId: z.string(),
|
|
452
|
+
name: z.string(),
|
|
453
|
+
color: intentCategoryColorSchema
|
|
454
|
+
});
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
456
|
+
id: z.string(),
|
|
457
|
+
name: z.string(),
|
|
458
|
+
color: intentCategoryColorSchema,
|
|
459
|
+
intentCount: z.number().int().nonnegative()
|
|
460
|
+
});
|
|
461
|
+
z.object({
|
|
462
|
+
id: z.string(),
|
|
463
|
+
createdAt: z.coerce.date(),
|
|
464
|
+
environmentId: z.string(),
|
|
465
|
+
toolName: z.string(),
|
|
466
|
+
message: z.string(),
|
|
467
|
+
clientName: z.string().nullable(),
|
|
468
|
+
categories: z.array(intentCategorySchema)
|
|
469
|
+
});
|
|
470
|
+
const signalCategorySchema = z.object({
|
|
471
|
+
id: z.string(),
|
|
472
|
+
name: z.string(),
|
|
473
|
+
color: intentCategoryColorSchema
|
|
474
|
+
});
|
|
475
|
+
z.discriminatedUnion("kind", [
|
|
476
|
+
z.object({
|
|
477
|
+
kind: z.literal("new"),
|
|
478
|
+
category: signalCategorySchema,
|
|
479
|
+
currentCount: z.number().int().nonnegative(),
|
|
480
|
+
currentShare: z.number()
|
|
481
|
+
}),
|
|
482
|
+
z.object({
|
|
483
|
+
kind: z.literal("resurging"),
|
|
484
|
+
category: signalCategorySchema,
|
|
485
|
+
currentCount: z.number().int().nonnegative(),
|
|
486
|
+
daysQuiet: z.number(),
|
|
487
|
+
currentShare: z.number()
|
|
488
|
+
}),
|
|
489
|
+
z.object({
|
|
490
|
+
kind: z.literal("spike"),
|
|
491
|
+
category: signalCategorySchema,
|
|
492
|
+
currentCount: z.number().int().nonnegative(),
|
|
493
|
+
previousCount: z.number().int().nonnegative(),
|
|
494
|
+
currentShare: z.number(),
|
|
495
|
+
previousShare: z.number(),
|
|
496
|
+
changeRatio: z.number()
|
|
497
|
+
}),
|
|
498
|
+
z.object({
|
|
499
|
+
kind: z.literal("declining"),
|
|
500
|
+
category: signalCategorySchema,
|
|
501
|
+
currentCount: z.number().int().nonnegative(),
|
|
502
|
+
previousCount: z.number().int().nonnegative(),
|
|
503
|
+
currentShare: z.number(),
|
|
504
|
+
previousShare: z.number(),
|
|
505
|
+
changeRatio: z.number()
|
|
506
|
+
})
|
|
507
|
+
]);
|
|
508
|
+
z.discriminatedUnion("kind", [z.object({
|
|
509
|
+
kind: z.literal("existing"),
|
|
510
|
+
categoryId: z.string(),
|
|
511
|
+
categoryName: z.string(),
|
|
512
|
+
intentIds: z.array(z.string())
|
|
513
|
+
}), z.object({
|
|
514
|
+
kind: z.literal("new"),
|
|
515
|
+
categoryName: z.string(),
|
|
516
|
+
intentIds: z.array(z.string())
|
|
517
|
+
})]);
|
|
518
|
+
z.object({
|
|
519
|
+
id: z.string(),
|
|
520
|
+
teamId: z.string(),
|
|
521
|
+
email: z.string(),
|
|
522
|
+
expiresAt: z.coerce.date(),
|
|
523
|
+
createdAt: z.coerce.date(),
|
|
524
|
+
updatedAt: z.coerce.date()
|
|
525
|
+
});
|
|
526
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
527
|
+
type: z.literal("mcp_request"),
|
|
528
|
+
method: z.string()
|
|
529
|
+
});
|
|
530
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
531
|
+
type: z.literal("mcp_error"),
|
|
532
|
+
method: z.string(),
|
|
533
|
+
error: z.string()
|
|
534
|
+
});
|
|
535
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
536
|
+
z.enum([
|
|
537
|
+
"INFO",
|
|
538
|
+
"WARNING",
|
|
539
|
+
"DEBUG",
|
|
540
|
+
"ERROR"
|
|
541
|
+
]);
|
|
542
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
543
|
+
const MCP_CLIENT_GROUPS = [
|
|
544
|
+
{
|
|
545
|
+
id: "claude_code",
|
|
546
|
+
label: "Claude Code",
|
|
547
|
+
vendor: "anthropic",
|
|
548
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
id: "claude",
|
|
552
|
+
label: "Claude",
|
|
553
|
+
vendor: "anthropic",
|
|
554
|
+
rawNames: [
|
|
555
|
+
"Anthropic/ClaudeAI",
|
|
556
|
+
"claude-ai",
|
|
557
|
+
"claude",
|
|
558
|
+
"Claude",
|
|
559
|
+
"claude-desktop",
|
|
560
|
+
"claude-desktop-3p"
|
|
561
|
+
]
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
id: "claude_mobile",
|
|
565
|
+
label: "Claude mobile",
|
|
566
|
+
vendor: "anthropic",
|
|
567
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
id: "claude_cowork",
|
|
571
|
+
label: "Claude Cowork",
|
|
572
|
+
vendor: "anthropic",
|
|
573
|
+
rawNames: ["Anthropic/Cowork"]
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
id: "claude_toolbox",
|
|
577
|
+
label: "Claude Toolbox",
|
|
578
|
+
vendor: "anthropic",
|
|
579
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
id: "anthropic_api",
|
|
583
|
+
label: "Anthropic API",
|
|
584
|
+
vendor: "anthropic",
|
|
585
|
+
rawNames: ["Anthropic/API"]
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
id: "anthropic_connector_refresh",
|
|
589
|
+
label: "Anthropic (connector refresh)",
|
|
590
|
+
vendor: "anthropic",
|
|
591
|
+
rawNames: ["Anthropic"]
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
id: "codex",
|
|
595
|
+
label: "Codex",
|
|
596
|
+
vendor: "openai",
|
|
597
|
+
rawNames: [
|
|
598
|
+
"codex-mcp-client",
|
|
599
|
+
"codex",
|
|
600
|
+
"Codex",
|
|
601
|
+
"codex-cli",
|
|
602
|
+
"openai-mcp (Codex)"
|
|
603
|
+
]
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
id: "chatgpt",
|
|
607
|
+
label: "ChatGPT",
|
|
608
|
+
vendor: "openai",
|
|
609
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
id: "openai_responses_api",
|
|
613
|
+
label: "OpenAI Responses API",
|
|
614
|
+
vendor: "openai",
|
|
615
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
id: "openai_agent_builder",
|
|
619
|
+
label: "OpenAI Agent Builder",
|
|
620
|
+
vendor: "openai",
|
|
621
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
id: "openai_other",
|
|
625
|
+
label: "OpenAI Other",
|
|
626
|
+
vendor: "openai",
|
|
627
|
+
rawNames: ["openai-mcp"]
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
id: "cursor",
|
|
631
|
+
label: "Cursor",
|
|
632
|
+
vendor: "cursor",
|
|
633
|
+
rawNames: [
|
|
634
|
+
"cursor-vscode",
|
|
635
|
+
"Cursor",
|
|
636
|
+
"cursor"
|
|
637
|
+
]
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
id: "cline",
|
|
641
|
+
label: "Cline",
|
|
642
|
+
vendor: "cline",
|
|
643
|
+
rawNames: [
|
|
644
|
+
"Cline",
|
|
645
|
+
"cline",
|
|
646
|
+
"@cline/core"
|
|
647
|
+
]
|
|
648
|
+
},
|
|
649
|
+
{
|
|
650
|
+
id: "github_copilot",
|
|
651
|
+
label: "GitHub Copilot",
|
|
652
|
+
vendor: "githubCopilot",
|
|
653
|
+
rawNames: [
|
|
654
|
+
"Copilot",
|
|
655
|
+
"github-copilot-developer",
|
|
656
|
+
"Copilot MCP Gateway",
|
|
657
|
+
"Xcode/copilot-xcode"
|
|
658
|
+
]
|
|
659
|
+
},
|
|
660
|
+
{
|
|
661
|
+
id: "gemini_cli",
|
|
662
|
+
label: "Gemini CLI",
|
|
663
|
+
vendor: "google",
|
|
664
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
id: "antigravity",
|
|
668
|
+
label: "Antigravity",
|
|
669
|
+
vendor: "google",
|
|
670
|
+
rawNames: ["antigravity-client"]
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
id: "gemini",
|
|
674
|
+
label: "Gemini",
|
|
675
|
+
vendor: "google",
|
|
676
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
id: "windsurf",
|
|
680
|
+
label: "Windsurf",
|
|
681
|
+
vendor: "windsurf",
|
|
682
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
683
|
+
},
|
|
684
|
+
{
|
|
685
|
+
id: "mistral",
|
|
686
|
+
label: "Mistral / Le Chat",
|
|
687
|
+
vendor: "mistral",
|
|
688
|
+
rawNames: ["Mistral"],
|
|
689
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
id: "n8n",
|
|
693
|
+
label: "n8n",
|
|
694
|
+
vendor: "n8n",
|
|
695
|
+
rawNames: [
|
|
696
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
697
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
698
|
+
"n8n"
|
|
699
|
+
]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "alpic_playground",
|
|
703
|
+
label: "Alpic Playground",
|
|
704
|
+
vendor: "alpic",
|
|
705
|
+
rawNames: ["alpic-playground", "playground"]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
id: "opencode",
|
|
709
|
+
label: "opencode",
|
|
710
|
+
vendor: "opencode",
|
|
711
|
+
rawNames: ["opencode"]
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
id: "zed",
|
|
715
|
+
label: "Zed",
|
|
716
|
+
vendor: "zed",
|
|
717
|
+
rawNames: ["Zed", "zed"]
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
id: "zapier",
|
|
721
|
+
label: "Zapier",
|
|
722
|
+
vendor: "zapier",
|
|
723
|
+
rawNames: ["Zapier", "zapier"]
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
id: "make",
|
|
727
|
+
label: "Make",
|
|
728
|
+
vendor: "make",
|
|
729
|
+
rawNames: ["Make", "make"]
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
id: "librechat",
|
|
733
|
+
label: "LibreChat",
|
|
734
|
+
vendor: "mcp",
|
|
735
|
+
rawNames: ["LibreChat", "librechat"]
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
id: "jan",
|
|
739
|
+
label: "Jan",
|
|
740
|
+
vendor: "mcp",
|
|
741
|
+
rawNames: ["Jan", "jan"]
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
id: "goose",
|
|
745
|
+
label: "goose",
|
|
746
|
+
vendor: "mcp",
|
|
747
|
+
rawNames: ["goose", "Goose"]
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
id: "mcphost",
|
|
751
|
+
label: "mcphost",
|
|
752
|
+
vendor: "mcp",
|
|
753
|
+
rawNames: ["mcphost"]
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
id: "mcporter",
|
|
757
|
+
label: "mcporter",
|
|
758
|
+
vendor: "mcp",
|
|
759
|
+
rawNames: ["mcporter"]
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
id: "rmcp",
|
|
763
|
+
label: "rmcp",
|
|
764
|
+
vendor: "mcp",
|
|
765
|
+
rawNames: ["rmcp"]
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
id: "unnamed_client",
|
|
769
|
+
label: "Unnamed client",
|
|
770
|
+
vendor: "mcp",
|
|
771
|
+
rawNames: [
|
|
772
|
+
"mcp",
|
|
773
|
+
"unknown",
|
|
774
|
+
""
|
|
775
|
+
]
|
|
776
|
+
}
|
|
777
|
+
];
|
|
778
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
779
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
780
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
781
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
782
|
+
const runtimeSchema = z.enum([
|
|
783
|
+
"python3.13",
|
|
784
|
+
"python3.14",
|
|
785
|
+
"node22",
|
|
786
|
+
"node24"
|
|
787
|
+
]);
|
|
788
|
+
const transportSchema = z.enum([
|
|
789
|
+
"stdio",
|
|
790
|
+
"sse",
|
|
791
|
+
"streamablehttp"
|
|
792
|
+
]);
|
|
793
|
+
z.object({
|
|
794
|
+
id: z.string(),
|
|
795
|
+
name: z.string(),
|
|
796
|
+
teamId: z.string(),
|
|
797
|
+
sourceRepository: z.string().nullable(),
|
|
798
|
+
createdAt: z.coerce.date().optional(),
|
|
799
|
+
runtime: runtimeSchema,
|
|
800
|
+
transport: transportSchema.nullable(),
|
|
801
|
+
rootDirectory: z.string().nullable(),
|
|
802
|
+
installCommand: z.string().nullable(),
|
|
803
|
+
buildCommand: z.string().nullable(),
|
|
804
|
+
buildOutputDir: z.string().nullable(),
|
|
805
|
+
startCommand: z.string().nullable(),
|
|
806
|
+
fixedOutboundIp: z.boolean(),
|
|
807
|
+
environments: z.array(environmentWithDomainsSchema),
|
|
808
|
+
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
809
|
+
});
|
|
810
|
+
const domainFailureReasonSchema = z.enum([
|
|
811
|
+
"caa",
|
|
812
|
+
"dns",
|
|
813
|
+
"invalid_domain",
|
|
814
|
+
"other"
|
|
815
|
+
]);
|
|
816
|
+
const projectDomainMappingSchema = z.object({
|
|
817
|
+
pathPrefix: z.string(),
|
|
818
|
+
environment: environmentSchema$1
|
|
819
|
+
});
|
|
820
|
+
z.object({
|
|
821
|
+
name: z.string(),
|
|
822
|
+
createdAt: z.coerce.date(),
|
|
823
|
+
status: z.enum([
|
|
824
|
+
"ongoing",
|
|
825
|
+
"deployed",
|
|
826
|
+
"failed"
|
|
827
|
+
]),
|
|
828
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
829
|
+
environment: environmentSchema$1,
|
|
830
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
831
|
+
});
|
|
832
|
+
const serverFieldsSchema$1 = z.object({
|
|
833
|
+
$schema: z.string(),
|
|
834
|
+
name: z.string(),
|
|
835
|
+
description: z.string(),
|
|
836
|
+
version: z.string().optional(),
|
|
837
|
+
title: z.string().optional(),
|
|
838
|
+
websiteUrl: z.string().optional(),
|
|
839
|
+
icons: z.array(z.object({
|
|
840
|
+
src: z.string(),
|
|
841
|
+
mimeType: z.string().optional(),
|
|
842
|
+
sizes: z.array(z.string()).optional()
|
|
843
|
+
})).optional(),
|
|
844
|
+
remotes: z.array(z.object({
|
|
845
|
+
type: z.string(),
|
|
846
|
+
url: z.string().optional(),
|
|
847
|
+
headers: z.array(z.object({
|
|
848
|
+
name: z.string(),
|
|
849
|
+
description: z.string(),
|
|
850
|
+
isRequired: z.boolean().optional(),
|
|
851
|
+
isSecret: z.boolean().optional()
|
|
852
|
+
})).optional()
|
|
853
|
+
})).optional()
|
|
854
|
+
}).catchall(z.unknown());
|
|
855
|
+
z.object({
|
|
856
|
+
serverFields: serverFieldsSchema$1,
|
|
857
|
+
source: z.enum(["registry", "defaults"])
|
|
858
|
+
});
|
|
859
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
860
|
+
const clampStringField = (field) => {
|
|
861
|
+
const max = field.maxLength;
|
|
862
|
+
if (max === null) return field;
|
|
863
|
+
const clamped = z.string().overwrite((value) => value.slice(0, max)).max(max);
|
|
864
|
+
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
865
|
+
return field.description ? withMin.describe(field.description) : withMin;
|
|
866
|
+
};
|
|
867
|
+
const unboundedArrayField = (field) => {
|
|
868
|
+
const unbounded = z.array(field.element);
|
|
869
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
870
|
+
};
|
|
871
|
+
const toolDefinitionSchema = z.object({
|
|
872
|
+
name: z.string(),
|
|
873
|
+
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
874
|
+
description: z.string().optional(),
|
|
875
|
+
annotations: z.object({
|
|
876
|
+
readOnlyHint: z.boolean().optional(),
|
|
877
|
+
destructiveHint: z.boolean().optional(),
|
|
878
|
+
openWorldHint: z.boolean().optional(),
|
|
879
|
+
idempotentHint: z.boolean().optional()
|
|
124
880
|
}).optional()
|
|
125
881
|
});
|
|
882
|
+
const positiveTestCaseSchema = z.object({
|
|
883
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
884
|
+
userPrompt: z.string().min(1).describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
885
|
+
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
886
|
+
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
887
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
888
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
889
|
+
scenario: z.string().optional(),
|
|
890
|
+
userPrompt: z.string().optional()
|
|
891
|
+
});
|
|
892
|
+
const blankPositiveTestCase = () => ({
|
|
893
|
+
scenario: "",
|
|
894
|
+
userPrompt: "",
|
|
895
|
+
toolTriggered: "",
|
|
896
|
+
expectedOutput: ""
|
|
897
|
+
});
|
|
898
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
899
|
+
const screenshotEntrySchema = z.object({
|
|
900
|
+
prompt: z.string(),
|
|
901
|
+
url: z.url()
|
|
902
|
+
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
903
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
904
|
+
/** Accepts either a valid email or URL. */
|
|
905
|
+
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
906
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
907
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
908
|
+
const chatgptCategorySchema = z.enum([
|
|
909
|
+
"BUSINESS",
|
|
910
|
+
"COLLABORATION",
|
|
911
|
+
"DESIGN",
|
|
912
|
+
"DEVELOPER_TOOLS",
|
|
913
|
+
"EDUCATION",
|
|
914
|
+
"ENTERTAINMENT",
|
|
915
|
+
"FINANCE",
|
|
916
|
+
"FOOD",
|
|
917
|
+
"LIFESTYLE",
|
|
918
|
+
"NEWS",
|
|
919
|
+
"PRODUCTIVITY",
|
|
920
|
+
"SHOPPING",
|
|
921
|
+
"TRAVEL"
|
|
922
|
+
]);
|
|
923
|
+
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
924
|
+
const chatgptCountryCodeSchema = z.enum([
|
|
925
|
+
"AD",
|
|
926
|
+
"AE",
|
|
927
|
+
"AF",
|
|
928
|
+
"AG",
|
|
929
|
+
"AL",
|
|
930
|
+
"AM",
|
|
931
|
+
"AO",
|
|
932
|
+
"AR",
|
|
933
|
+
"AT",
|
|
934
|
+
"AU",
|
|
935
|
+
"AW",
|
|
936
|
+
"AX",
|
|
937
|
+
"AZ",
|
|
938
|
+
"BA",
|
|
939
|
+
"BB",
|
|
940
|
+
"BD",
|
|
941
|
+
"BE",
|
|
942
|
+
"BF",
|
|
943
|
+
"BG",
|
|
944
|
+
"BH",
|
|
945
|
+
"BI",
|
|
946
|
+
"BJ",
|
|
947
|
+
"BL",
|
|
948
|
+
"BM",
|
|
949
|
+
"BN",
|
|
950
|
+
"BO",
|
|
951
|
+
"BR",
|
|
952
|
+
"BS",
|
|
953
|
+
"BT",
|
|
954
|
+
"BW",
|
|
955
|
+
"BZ",
|
|
956
|
+
"CA",
|
|
957
|
+
"CD",
|
|
958
|
+
"CF",
|
|
959
|
+
"CG",
|
|
960
|
+
"CH",
|
|
961
|
+
"CI",
|
|
962
|
+
"CL",
|
|
963
|
+
"CM",
|
|
964
|
+
"CO",
|
|
965
|
+
"CR",
|
|
966
|
+
"CV",
|
|
967
|
+
"CY",
|
|
968
|
+
"CZ",
|
|
969
|
+
"DE",
|
|
970
|
+
"DJ",
|
|
971
|
+
"DK",
|
|
972
|
+
"DM",
|
|
973
|
+
"DO",
|
|
974
|
+
"DZ",
|
|
975
|
+
"EC",
|
|
976
|
+
"EE",
|
|
977
|
+
"EG",
|
|
978
|
+
"ER",
|
|
979
|
+
"ES",
|
|
980
|
+
"ET",
|
|
981
|
+
"FI",
|
|
982
|
+
"FJ",
|
|
983
|
+
"FM",
|
|
984
|
+
"FO",
|
|
985
|
+
"FR",
|
|
986
|
+
"GA",
|
|
987
|
+
"GB",
|
|
988
|
+
"GD",
|
|
989
|
+
"GE",
|
|
990
|
+
"GF",
|
|
991
|
+
"GH",
|
|
992
|
+
"GL",
|
|
993
|
+
"GM",
|
|
994
|
+
"GN",
|
|
995
|
+
"GP",
|
|
996
|
+
"GQ",
|
|
997
|
+
"GR",
|
|
998
|
+
"GT",
|
|
999
|
+
"GW",
|
|
1000
|
+
"GY",
|
|
1001
|
+
"HN",
|
|
1002
|
+
"HR",
|
|
1003
|
+
"HT",
|
|
1004
|
+
"HU",
|
|
1005
|
+
"ID",
|
|
1006
|
+
"IE",
|
|
1007
|
+
"IL",
|
|
1008
|
+
"IN",
|
|
1009
|
+
"IQ",
|
|
1010
|
+
"IS",
|
|
1011
|
+
"IT",
|
|
1012
|
+
"JM",
|
|
1013
|
+
"JO",
|
|
1014
|
+
"JP",
|
|
1015
|
+
"KE",
|
|
1016
|
+
"KG",
|
|
1017
|
+
"KH",
|
|
1018
|
+
"KI",
|
|
1019
|
+
"KM",
|
|
1020
|
+
"KN",
|
|
1021
|
+
"KR",
|
|
1022
|
+
"KW",
|
|
1023
|
+
"KY",
|
|
1024
|
+
"KZ",
|
|
1025
|
+
"LA",
|
|
1026
|
+
"LB",
|
|
1027
|
+
"LC",
|
|
1028
|
+
"LI",
|
|
1029
|
+
"LK",
|
|
1030
|
+
"LR",
|
|
1031
|
+
"LS",
|
|
1032
|
+
"LT",
|
|
1033
|
+
"LU",
|
|
1034
|
+
"LV",
|
|
1035
|
+
"LY",
|
|
1036
|
+
"MA",
|
|
1037
|
+
"MC",
|
|
1038
|
+
"MD",
|
|
1039
|
+
"ME",
|
|
1040
|
+
"MF",
|
|
1041
|
+
"MG",
|
|
1042
|
+
"MH",
|
|
1043
|
+
"MK",
|
|
1044
|
+
"ML",
|
|
1045
|
+
"MM",
|
|
1046
|
+
"MN",
|
|
1047
|
+
"MQ",
|
|
1048
|
+
"MR",
|
|
1049
|
+
"MT",
|
|
1050
|
+
"MU",
|
|
1051
|
+
"MV",
|
|
1052
|
+
"MW",
|
|
1053
|
+
"MX",
|
|
1054
|
+
"MY",
|
|
1055
|
+
"MZ",
|
|
1056
|
+
"NA",
|
|
1057
|
+
"NC",
|
|
1058
|
+
"NE",
|
|
1059
|
+
"NG",
|
|
1060
|
+
"NI",
|
|
1061
|
+
"NL",
|
|
1062
|
+
"NO",
|
|
1063
|
+
"NP",
|
|
1064
|
+
"NR",
|
|
1065
|
+
"NZ",
|
|
1066
|
+
"OM",
|
|
1067
|
+
"PA",
|
|
1068
|
+
"PE",
|
|
1069
|
+
"PF",
|
|
1070
|
+
"PG",
|
|
1071
|
+
"PH",
|
|
1072
|
+
"PK",
|
|
1073
|
+
"PL",
|
|
1074
|
+
"PM",
|
|
1075
|
+
"PS",
|
|
1076
|
+
"PT",
|
|
1077
|
+
"PW",
|
|
1078
|
+
"PY",
|
|
1079
|
+
"QA",
|
|
1080
|
+
"RE",
|
|
1081
|
+
"RO",
|
|
1082
|
+
"RS",
|
|
1083
|
+
"RW",
|
|
1084
|
+
"SA",
|
|
1085
|
+
"SB",
|
|
1086
|
+
"SC",
|
|
1087
|
+
"SD",
|
|
1088
|
+
"SE",
|
|
1089
|
+
"SG",
|
|
1090
|
+
"SH",
|
|
1091
|
+
"SI",
|
|
1092
|
+
"SJ",
|
|
1093
|
+
"SK",
|
|
1094
|
+
"SL",
|
|
1095
|
+
"SM",
|
|
1096
|
+
"SN",
|
|
1097
|
+
"SO",
|
|
1098
|
+
"SR",
|
|
1099
|
+
"SS",
|
|
1100
|
+
"ST",
|
|
1101
|
+
"SV",
|
|
1102
|
+
"SZ",
|
|
1103
|
+
"TD",
|
|
1104
|
+
"TF",
|
|
1105
|
+
"TG",
|
|
1106
|
+
"TH",
|
|
1107
|
+
"TJ",
|
|
1108
|
+
"TL",
|
|
1109
|
+
"TM",
|
|
1110
|
+
"TN",
|
|
1111
|
+
"TO",
|
|
1112
|
+
"TR",
|
|
1113
|
+
"TT",
|
|
1114
|
+
"TV",
|
|
1115
|
+
"TW",
|
|
1116
|
+
"TZ",
|
|
1117
|
+
"UA",
|
|
1118
|
+
"UG",
|
|
1119
|
+
"US",
|
|
1120
|
+
"UY",
|
|
1121
|
+
"UZ",
|
|
1122
|
+
"VA",
|
|
1123
|
+
"VC",
|
|
1124
|
+
"VN",
|
|
1125
|
+
"VU",
|
|
1126
|
+
"WF",
|
|
1127
|
+
"WS",
|
|
1128
|
+
"YE",
|
|
1129
|
+
"YT",
|
|
1130
|
+
"ZA",
|
|
1131
|
+
"ZM",
|
|
1132
|
+
"ZW"
|
|
1133
|
+
]);
|
|
1134
|
+
const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
|
|
1135
|
+
z.object({ mode: z.literal("all") }),
|
|
1136
|
+
z.object({
|
|
1137
|
+
mode: z.literal("allow"),
|
|
1138
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
1139
|
+
}),
|
|
1140
|
+
z.object({
|
|
1141
|
+
mode: z.literal("block"),
|
|
1142
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
1143
|
+
})
|
|
1144
|
+
]);
|
|
1145
|
+
const chatgptTranslationLocaleSchema = z.enum([
|
|
1146
|
+
"am",
|
|
1147
|
+
"ar",
|
|
1148
|
+
"bg-BG",
|
|
1149
|
+
"bn-BD",
|
|
1150
|
+
"bs-BA",
|
|
1151
|
+
"ca-ES",
|
|
1152
|
+
"cs-CZ",
|
|
1153
|
+
"da-DK",
|
|
1154
|
+
"de-DE",
|
|
1155
|
+
"el-GR",
|
|
1156
|
+
"es-419",
|
|
1157
|
+
"es-ES",
|
|
1158
|
+
"et-EE",
|
|
1159
|
+
"fi-FI",
|
|
1160
|
+
"fr-CA",
|
|
1161
|
+
"fr-FR",
|
|
1162
|
+
"gu-IN",
|
|
1163
|
+
"hi-IN",
|
|
1164
|
+
"hr-HR",
|
|
1165
|
+
"hu-HU",
|
|
1166
|
+
"hy-AM",
|
|
1167
|
+
"id-ID",
|
|
1168
|
+
"is-IS",
|
|
1169
|
+
"it-IT",
|
|
1170
|
+
"ja-JP",
|
|
1171
|
+
"ka-GE",
|
|
1172
|
+
"kk",
|
|
1173
|
+
"kn-IN",
|
|
1174
|
+
"ko-KR",
|
|
1175
|
+
"lt",
|
|
1176
|
+
"lv-LV",
|
|
1177
|
+
"mk-MK",
|
|
1178
|
+
"ml",
|
|
1179
|
+
"mn",
|
|
1180
|
+
"mr-IN",
|
|
1181
|
+
"ms-MY",
|
|
1182
|
+
"my-MM",
|
|
1183
|
+
"nb-NO",
|
|
1184
|
+
"nl-NL",
|
|
1185
|
+
"pa",
|
|
1186
|
+
"pl-PL",
|
|
1187
|
+
"pt-BR",
|
|
1188
|
+
"pt-PT",
|
|
1189
|
+
"ro-RO",
|
|
1190
|
+
"ru-RU",
|
|
1191
|
+
"sk-SK",
|
|
1192
|
+
"sl-SI",
|
|
1193
|
+
"so-SO",
|
|
1194
|
+
"sq-AL",
|
|
1195
|
+
"sr-RS",
|
|
1196
|
+
"sv-SE",
|
|
1197
|
+
"sw-TZ",
|
|
1198
|
+
"ta-IN",
|
|
1199
|
+
"te-IN",
|
|
1200
|
+
"th-TH",
|
|
1201
|
+
"tl",
|
|
1202
|
+
"tr-TR",
|
|
1203
|
+
"uk-UA",
|
|
1204
|
+
"ur",
|
|
1205
|
+
"vi-VN",
|
|
1206
|
+
"zh-CN",
|
|
1207
|
+
"zh-HK",
|
|
1208
|
+
"zh-TW"
|
|
1209
|
+
]);
|
|
1210
|
+
const negativeTestCaseSchema = z.object({
|
|
1211
|
+
scenario: z.string().min(1),
|
|
1212
|
+
userPrompt: z.string().min(1)
|
|
1213
|
+
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1214
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1215
|
+
scenario: z.string().optional(),
|
|
1216
|
+
userPrompt: z.string().optional()
|
|
1217
|
+
});
|
|
1218
|
+
const blankNegativeTestCase = () => ({
|
|
1219
|
+
scenario: "",
|
|
1220
|
+
userPrompt: ""
|
|
1221
|
+
});
|
|
1222
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
1223
|
+
const chatgptToolJustificationSchema = z.object({
|
|
1224
|
+
toolName: z.string(),
|
|
1225
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
1226
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
1227
|
+
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
1228
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
1229
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
1230
|
+
const chatgptTaglineSchema = z.string().max(30);
|
|
1231
|
+
const chatgptDescriptionSchema = z.string();
|
|
1232
|
+
const chatgptTranslationSchema = z.object({
|
|
1233
|
+
locale: chatgptTranslationLocaleSchema,
|
|
1234
|
+
tagline: chatgptTaglineSchema,
|
|
1235
|
+
description: chatgptDescriptionSchema
|
|
1236
|
+
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
1237
|
+
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
1238
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
1239
|
+
const chatgptSubmissionFormDataSchema = z.object({
|
|
1240
|
+
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
1241
|
+
logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
|
|
1242
|
+
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
1243
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
1244
|
+
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)."),
|
|
1245
|
+
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
1246
|
+
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
1247
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
1248
|
+
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
1249
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1250
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
1251
|
+
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."),
|
|
1252
|
+
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."),
|
|
1253
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
1254
|
+
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
1255
|
+
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1256
|
+
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
|
|
1257
|
+
skills: z.array(chatgptSkillSchema).optional().describe("Skills the server exposes over MCP (auto-populated from the production server's manifest). Left unset when the server does not advertise the skills extension, which is a different state from advertising it and exposing none."),
|
|
1258
|
+
testCases: z.array(positiveTestCaseSchema).length(5).describe("Exactly 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Collectively cover the full capability across different flow stages (initial search or browse, market or locale handling, post-interaction detail, an action ChatGPT performs on the user's behalf, and a conversion or secondary tool) rather than five variations of the same first step."),
|
|
1259
|
+
negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
1260
|
+
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
1261
|
+
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1262
|
+
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
1263
|
+
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
1264
|
+
});
|
|
1265
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1266
|
+
tagline: z.string().optional(),
|
|
1267
|
+
companyUrl: z.string().optional(),
|
|
1268
|
+
supportChannel: z.string().optional(),
|
|
1269
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1270
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1271
|
+
demoRecordingUrl: z.string().optional(),
|
|
1272
|
+
serverUrl: z.string().optional(),
|
|
1273
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1274
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1275
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1276
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1277
|
+
});
|
|
1278
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1279
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1280
|
+
appName: true,
|
|
1281
|
+
developerName: true,
|
|
1282
|
+
serverUrl: true,
|
|
1283
|
+
tools: true,
|
|
1284
|
+
skills: true,
|
|
1285
|
+
authentication: true
|
|
1286
|
+
});
|
|
1287
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1288
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1289
|
+
tagline: true,
|
|
1290
|
+
description: true,
|
|
1291
|
+
category: true,
|
|
1292
|
+
testCases: true,
|
|
1293
|
+
negativeTestCases: true,
|
|
1294
|
+
toolJustifications: true
|
|
1295
|
+
}).extend({
|
|
1296
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1297
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1298
|
+
}).extend({
|
|
1299
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1300
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1301
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1302
|
+
});
|
|
1303
|
+
const claudeCategorySchema = z.enum([
|
|
1304
|
+
"Productivity",
|
|
1305
|
+
"Communication",
|
|
1306
|
+
"Data & Analytics",
|
|
1307
|
+
"Development tools",
|
|
1308
|
+
"Financial Services",
|
|
1309
|
+
"Consumer Health",
|
|
1310
|
+
"Health & Life Sciences",
|
|
1311
|
+
"Media & Entertainment",
|
|
1312
|
+
"Commerce & Shopping",
|
|
1313
|
+
"Legal",
|
|
1314
|
+
"Sales and marketing",
|
|
1315
|
+
"Creative",
|
|
1316
|
+
"Nonprofit",
|
|
1317
|
+
"Education",
|
|
1318
|
+
"Other"
|
|
1319
|
+
]);
|
|
1320
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
1321
|
+
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
1322
|
+
"read_only",
|
|
1323
|
+
"write_only",
|
|
1324
|
+
"read_write"
|
|
1325
|
+
]);
|
|
1326
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1327
|
+
"oauth_dcr",
|
|
1328
|
+
"oauth_cimd",
|
|
1329
|
+
"oauth_anthropic_creds",
|
|
1330
|
+
"custom_connection",
|
|
1331
|
+
"none"
|
|
1332
|
+
]);
|
|
1333
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1334
|
+
"first_party",
|
|
1335
|
+
"proxied",
|
|
1336
|
+
"third_party"
|
|
1337
|
+
]);
|
|
1338
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1339
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1340
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1341
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1342
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1343
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1344
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1345
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1346
|
+
"Public documentation for this connector will be live by the publish date."
|
|
1347
|
+
]);
|
|
1348
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
1349
|
+
const claudeSubmissionFormDataSchema = z.object({
|
|
1350
|
+
serverUrl: z.url().describe(`The full https:// URL where your MCP server is hosted and reachable. In the claude.ai wizard this is read live
|
|
1351
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1352
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1353
|
+
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
|
|
1354
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1355
|
+
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.
|
|
1356
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1357
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1358
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1359
|
+
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
|
|
1360
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1361
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1362
|
+
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
|
|
1363
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1364
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1365
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1366
|
+
by your publish date.`),
|
|
1367
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1368
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1369
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1370
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1371
|
+
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
|
|
1372
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1373
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1374
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1375
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1376
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1377
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1378
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1379
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1380
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1381
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1382
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1383
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1384
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1385
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1386
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1387
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1388
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1389
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1390
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1391
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1392
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1393
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1394
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1395
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1396
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1397
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1398
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1399
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1400
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1401
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1402
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1403
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1404
|
+
fully populated account.`),
|
|
1405
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1406
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1407
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1408
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1409
|
+
});
|
|
1410
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1411
|
+
serverUrl: z.string().optional(),
|
|
1412
|
+
name: z.string().optional(),
|
|
1413
|
+
slug: z.string().optional(),
|
|
1414
|
+
oneLiner: z.string().optional(),
|
|
1415
|
+
description: z.string().optional(),
|
|
1416
|
+
iconUrl: z.string().optional(),
|
|
1417
|
+
documentation: z.string().optional(),
|
|
1418
|
+
support: z.string().optional(),
|
|
1419
|
+
privacyPolicy: z.string().optional(),
|
|
1420
|
+
companyWebsite: z.string().optional(),
|
|
1421
|
+
primaryContactEmail: z.string().optional(),
|
|
1422
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1423
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1424
|
+
});
|
|
1425
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1426
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1427
|
+
serverUrl: true,
|
|
1428
|
+
name: true,
|
|
1429
|
+
slug: true,
|
|
1430
|
+
companyName: true,
|
|
1431
|
+
primaryContactEmail: true,
|
|
1432
|
+
primaryContactName: true,
|
|
1433
|
+
readWriteCapabilities: true,
|
|
1434
|
+
authentication: true,
|
|
1435
|
+
apiOwnership: true,
|
|
1436
|
+
personalHealthData: true
|
|
1437
|
+
}).extend({
|
|
1438
|
+
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1439
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1440
|
+
});
|
|
1441
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1442
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1443
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1444
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1445
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1446
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1447
|
+
});
|
|
1448
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1449
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1450
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1451
|
+
});
|
|
1452
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1453
|
+
const byField = {};
|
|
1454
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1455
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1456
|
+
return byField;
|
|
1457
|
+
}
|
|
1458
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1459
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1460
|
+
"pass",
|
|
1461
|
+
"fail",
|
|
1462
|
+
"unverified"
|
|
1463
|
+
]);
|
|
1464
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1465
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1466
|
+
claudeai: ["privacyPolicy"]
|
|
1467
|
+
};
|
|
1468
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1469
|
+
const policyDisclosureSchema = z.enum([
|
|
1470
|
+
"dataCategories",
|
|
1471
|
+
"purposesOfUse",
|
|
1472
|
+
"recipients",
|
|
1473
|
+
"retention"
|
|
1474
|
+
]);
|
|
1475
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1476
|
+
field: verifiableUrlFieldSchema,
|
|
1477
|
+
url: z.string(),
|
|
1478
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1479
|
+
reason: z.string(),
|
|
1480
|
+
concerns: z.array(z.string()).optional(),
|
|
1481
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1482
|
+
});
|
|
1483
|
+
const urlVerificationSchema = z.object({
|
|
1484
|
+
verifiedAt: z.coerce.date(),
|
|
1485
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1486
|
+
});
|
|
1487
|
+
const pageKindSchema = z.enum([
|
|
1488
|
+
"expectedDocument",
|
|
1489
|
+
"errorPage",
|
|
1490
|
+
"loginWall",
|
|
1491
|
+
"parkedDomain",
|
|
1492
|
+
"comingSoon",
|
|
1493
|
+
"marketingPage",
|
|
1494
|
+
"unrelatedDocument"
|
|
1495
|
+
]);
|
|
1496
|
+
z.object({
|
|
1497
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1498
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1499
|
+
missingDisclosures: z.array(policyDisclosureSchema).describe("For a privacy policy only: which of the four required disclosures the text does not cover. Empty for every other page kind.")
|
|
1500
|
+
});
|
|
1501
|
+
const submissionMetaFieldsSchema = z.object({
|
|
1502
|
+
id: z.string(),
|
|
1503
|
+
environmentId: z.string(),
|
|
1504
|
+
auditId: z.string().nullable(),
|
|
1505
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1506
|
+
createdAt: z.coerce.date(),
|
|
1507
|
+
updatedAt: z.coerce.date()
|
|
1508
|
+
});
|
|
1509
|
+
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1510
|
+
platform: z.literal("claudeai"),
|
|
1511
|
+
formData: claudeSubmissionDraftSchema,
|
|
1512
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1513
|
+
});
|
|
1514
|
+
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1515
|
+
platform: z.literal("chatgpt"),
|
|
1516
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1517
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1518
|
+
});
|
|
1519
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1520
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1521
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1522
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1523
|
+
z.literal([
|
|
1524
|
+
100,
|
|
1525
|
+
75,
|
|
1526
|
+
50
|
|
1527
|
+
]);
|
|
1528
|
+
const subscriptionPlanSchema = z.enum([
|
|
1529
|
+
"pro",
|
|
1530
|
+
"business",
|
|
1531
|
+
"enterprise"
|
|
1532
|
+
]);
|
|
1533
|
+
z.object({ plan: subscriptionPlanSchema.nullable() });
|
|
1534
|
+
const customerCreditsSchema = z.object({
|
|
1535
|
+
balanceInCents: z.number(),
|
|
1536
|
+
expiresAt: z.number().nullable(),
|
|
1537
|
+
currency: z.string()
|
|
1538
|
+
});
|
|
1539
|
+
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1540
|
+
z.object({
|
|
1541
|
+
customerCredits: customerCreditsSchema.nullable(),
|
|
1542
|
+
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1543
|
+
});
|
|
1544
|
+
const metricsQueueEventSchema = z.object({
|
|
1545
|
+
ts: z.number().int(),
|
|
1546
|
+
method: z.string(),
|
|
1547
|
+
tool: z.string().nullable(),
|
|
1548
|
+
client: z.string(),
|
|
1549
|
+
sessionId: z.string().nullable(),
|
|
1550
|
+
durationMs: z.number().int(),
|
|
1551
|
+
outputTokens: z.number().int().nullable(),
|
|
1552
|
+
errorType: z.enum([
|
|
1553
|
+
"mcp_error",
|
|
1554
|
+
"tool_error",
|
|
1555
|
+
"timeout"
|
|
1556
|
+
]).nullable(),
|
|
1557
|
+
errorCode: z.number().int().nullable()
|
|
1558
|
+
});
|
|
1559
|
+
z.object({
|
|
1560
|
+
v: z.literal(1),
|
|
1561
|
+
envId: z.string(),
|
|
1562
|
+
events: z.array(metricsQueueEventSchema)
|
|
1563
|
+
});
|
|
1564
|
+
z.object({ v: z.number() });
|
|
1565
|
+
const telemetrySignalSchema = z.enum([
|
|
1566
|
+
"logs",
|
|
1567
|
+
"metrics",
|
|
1568
|
+
"traces"
|
|
1569
|
+
]);
|
|
1570
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1571
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1572
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1573
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1574
|
+
const otlpHeaderValueSchema = z.string().trim().max(OTLP_HEADER_VALUE_MAX_LENGTH).refine((value) => !/[\r\n]/.test(value), "Line breaks are not allowed in a header value");
|
|
1575
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1576
|
+
id: z.string(),
|
|
1577
|
+
name: otlpHeaderNameSchema,
|
|
1578
|
+
value: otlpHeaderValueSchema,
|
|
1579
|
+
isSecret: z.boolean()
|
|
1580
|
+
});
|
|
1581
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1582
|
+
"credentials",
|
|
1583
|
+
"wrong-path",
|
|
1584
|
+
"wrong-protocol",
|
|
1585
|
+
"invalid-payload",
|
|
1586
|
+
"partial-rejection",
|
|
1587
|
+
"blocked-target",
|
|
1588
|
+
"timeout",
|
|
1589
|
+
"unreachable",
|
|
1590
|
+
"receiver-error",
|
|
1591
|
+
"unexpected-status"
|
|
1592
|
+
]);
|
|
1593
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1594
|
+
z.object({
|
|
1595
|
+
id: z.string(),
|
|
1596
|
+
signal: telemetrySignalSchema,
|
|
1597
|
+
endpoint: otlpEndpointSchema,
|
|
1598
|
+
protocol: otlpProtocolSchema,
|
|
1599
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1600
|
+
status: telemetryDestinationStatusSchema,
|
|
1601
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1602
|
+
});
|
|
1603
|
+
//#endregion
|
|
1604
|
+
//#region src/auth-scope.ts
|
|
1605
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1606
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1607
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1608
|
+
const AUTH_SCOPE_USER = "user";
|
|
1609
|
+
//#endregion
|
|
1610
|
+
//#region src/schemas.ts
|
|
1611
|
+
const RESERVED_KEYS = [
|
|
1612
|
+
"_HANDLER",
|
|
1613
|
+
"_X_AMZN_TRACE_ID",
|
|
1614
|
+
"AWS_DEFAULT_REGION",
|
|
1615
|
+
"AWS_REGION",
|
|
1616
|
+
"AWS_EXECUTION_ENV",
|
|
1617
|
+
"AWS_LAMBDA_FUNCTION_NAME",
|
|
1618
|
+
"AWS_LAMBDA_FUNCTION_MEMORY_SIZE",
|
|
1619
|
+
"AWS_LAMBDA_FUNCTION_VERSION",
|
|
1620
|
+
"AWS_LAMBDA_INITIALIZATION_TYPE",
|
|
1621
|
+
"AWS_LAMBDA_LOG_GROUP_NAME",
|
|
1622
|
+
"AWS_LAMBDA_LOG_STREAM_NAME",
|
|
1623
|
+
"AWS_ACCESS_KEY",
|
|
1624
|
+
"AWS_ACCESS_KEY_ID",
|
|
1625
|
+
"AWS_SECRET_ACCESS_KEY",
|
|
1626
|
+
"AWS_SESSION_TOKEN",
|
|
1627
|
+
"AWS_LAMBDA_RUNTIME_API",
|
|
1628
|
+
"LAMBDA_TASK_ROOT",
|
|
1629
|
+
"LAMBDA_RUNTIME_DIR",
|
|
1630
|
+
"START_COMMAND",
|
|
1631
|
+
"ENVIRONMENT_ID",
|
|
1632
|
+
"PROJECT_BUILD_IMAGES_REPOSITORY_URI",
|
|
1633
|
+
"ENVIRONMENT_LAMBDA_FUNCTION_ARN",
|
|
1634
|
+
"SOURCE_REPOSITORY",
|
|
1635
|
+
"SOURCE_BRANCH",
|
|
1636
|
+
"SOURCE_REPOSITORY_CREDENTIALS",
|
|
1637
|
+
"RUNTIME",
|
|
1638
|
+
"ROOT_DIRECTORY",
|
|
1639
|
+
"BUILD_ARG_INSTALL_COMMAND",
|
|
1640
|
+
"BUILD_ARG_BUILD_COMMAND",
|
|
1641
|
+
"BUILD_ARG_BUILD_OUTPUT_DIR",
|
|
1642
|
+
"BUILD_ARG_START_COMMAND",
|
|
1643
|
+
"ALPIC_HOST",
|
|
1644
|
+
"ALPIC_CUSTOM_DOMAINS",
|
|
1645
|
+
"ALPIC_INTENT_META_KEY",
|
|
1646
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1647
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1648
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1649
|
+
];
|
|
1650
|
+
const environmentVariableSchema = z.object({
|
|
1651
|
+
key: z.string().min(2, "Key must be at least 2 characters").regex(/^[a-zA-Z]([a-zA-Z0-9_])+$/, "Key must start with a letter and contain only letters, numbers, and underscores").refine((key) => !RESERVED_KEYS.includes(key), "This key is reserved and cannot be used as an environment variable key"),
|
|
1652
|
+
value: z.string().min(1, "Value is required"),
|
|
1653
|
+
isSecret: z.boolean().default(false)
|
|
1654
|
+
});
|
|
1655
|
+
const environmentVariablesSchema = z.array(environmentVariableSchema);
|
|
1656
|
+
const updateEnvironmentVariableSchema = environmentVariableSchema.partial({
|
|
1657
|
+
value: true,
|
|
1658
|
+
isSecret: true
|
|
1659
|
+
});
|
|
1660
|
+
const buildSettingsSchema = z.object({
|
|
1661
|
+
installCommand: z.string().optional(),
|
|
1662
|
+
buildCommand: z.string().optional(),
|
|
1663
|
+
buildOutputDir: z.string().optional(),
|
|
1664
|
+
startCommand: z.string().optional()
|
|
1665
|
+
});
|
|
1666
|
+
const playgroundHeaderSchema = z.object({
|
|
1667
|
+
name: z.string().min(1).max(100),
|
|
1668
|
+
description: z.string().max(200),
|
|
1669
|
+
isRequired: z.boolean().default(false),
|
|
1670
|
+
isSecret: z.boolean().default(false)
|
|
1671
|
+
});
|
|
1672
|
+
const playgroundExamplePromptSchema = z.object({
|
|
1673
|
+
title: z.string().min(1).max(100),
|
|
1674
|
+
prompt: z.string().min(1).max(500)
|
|
1675
|
+
});
|
|
126
1676
|
const serverFieldsSchema = z.object({
|
|
127
1677
|
$schema: z.string(),
|
|
128
1678
|
name: z.string(),
|
|
@@ -148,6 +1698,14 @@ const serverFieldsSchema = z.object({
|
|
|
148
1698
|
});
|
|
149
1699
|
//#endregion
|
|
150
1700
|
//#region src/api.contract.ts
|
|
1701
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1702
|
+
try {
|
|
1703
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1704
|
+
return true;
|
|
1705
|
+
} catch {
|
|
1706
|
+
return false;
|
|
1707
|
+
}
|
|
1708
|
+
};
|
|
151
1709
|
const deploymentStatusSchema = z.enum([
|
|
152
1710
|
"ongoing",
|
|
153
1711
|
"deployed",
|
|
@@ -176,21 +1734,20 @@ const deploymentSchema = z.object({
|
|
|
176
1734
|
isCurrent: z.boolean(),
|
|
177
1735
|
deploymentPageUrl: z.url().nullable()
|
|
178
1736
|
});
|
|
179
|
-
const
|
|
1737
|
+
const isValidTimeInput = (value) => {
|
|
180
1738
|
if (ms(value) !== void 0) return true;
|
|
181
1739
|
return !Number.isNaN(new Date(value).getTime());
|
|
182
1740
|
};
|
|
183
|
-
const
|
|
1741
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1742
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1743
|
+
const createEnvironmentContractV1 = base.route({
|
|
184
1744
|
path: "/v1/environments",
|
|
185
1745
|
method: "POST",
|
|
186
1746
|
summary: "Create an environment",
|
|
187
1747
|
description: "Create an environment for a project",
|
|
188
1748
|
tags: ["environments"],
|
|
189
1749
|
successDescription: "The environment has been created successfully"
|
|
190
|
-
}).errors({
|
|
191
|
-
NOT_FOUND: {},
|
|
192
|
-
BAD_REQUEST: {}
|
|
193
|
-
}).input(z.object({
|
|
1750
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
194
1751
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
195
1752
|
name: z.string().min(1).describe("The name of the environment"),
|
|
196
1753
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -199,11 +1756,11 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
199
1756
|
id: z.string(),
|
|
200
1757
|
name: z.string(),
|
|
201
1758
|
sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
|
|
202
|
-
urls: z.array(z.
|
|
1759
|
+
urls: z.array(z.url()).describe("The URLs of the MCP server"),
|
|
203
1760
|
createdAt: z.coerce.date(),
|
|
204
1761
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
205
1762
|
}));
|
|
206
|
-
const getEnvironmentContractV1 =
|
|
1763
|
+
const getEnvironmentContractV1 = base.route({
|
|
207
1764
|
path: "/v1/environments/{environmentId}",
|
|
208
1765
|
method: "GET",
|
|
209
1766
|
summary: "Get an environment",
|
|
@@ -215,10 +1772,18 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
215
1772
|
name: z.string(),
|
|
216
1773
|
sourceBranch: z.string().nullable(),
|
|
217
1774
|
mcpServerUrl: z.string(),
|
|
218
|
-
domains: z.array(z.
|
|
1775
|
+
domains: z.array(z.hostname()),
|
|
219
1776
|
createdAt: z.coerce.date(),
|
|
220
1777
|
projectId: z.string()
|
|
221
1778
|
}));
|
|
1779
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1780
|
+
path: "/v1/environments/{environmentId}",
|
|
1781
|
+
method: "DELETE",
|
|
1782
|
+
summary: "Delete an environment",
|
|
1783
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1784
|
+
tags: ["environments"],
|
|
1785
|
+
successDescription: "The environment has been deleted successfully"
|
|
1786
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
222
1787
|
const domainSchema = z.object({
|
|
223
1788
|
domain: z.string(),
|
|
224
1789
|
status: z.enum([
|
|
@@ -260,7 +1825,7 @@ const projectOutputSchema = z.object({
|
|
|
260
1825
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
261
1826
|
environments: z.array(environmentSchema)
|
|
262
1827
|
});
|
|
263
|
-
const getProjectContractV1 =
|
|
1828
|
+
const getProjectContractV1 = base.route({
|
|
264
1829
|
path: "/v1/projects/{projectId}",
|
|
265
1830
|
method: "GET",
|
|
266
1831
|
summary: "Get a project",
|
|
@@ -268,15 +1833,15 @@ const getProjectContractV1 = oc.route({
|
|
|
268
1833
|
tags: ["projects"],
|
|
269
1834
|
successDescription: "The project details"
|
|
270
1835
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
271
|
-
const listProjectsContractV1 =
|
|
1836
|
+
const listProjectsContractV1 = base.route({
|
|
272
1837
|
path: "/v1/projects",
|
|
273
1838
|
method: "GET",
|
|
274
1839
|
summary: "List projects",
|
|
275
1840
|
description: "List all projects for a team",
|
|
276
1841
|
tags: ["projects"],
|
|
277
1842
|
successDescription: "The list of projects"
|
|
278
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
279
|
-
const createProjectContractV1 =
|
|
1843
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1844
|
+
const createProjectContractV1 = base.route({
|
|
280
1845
|
path: "/v1/projects",
|
|
281
1846
|
method: "POST",
|
|
282
1847
|
summary: "Create a project",
|
|
@@ -285,7 +1850,7 @@ const createProjectContractV1 = oc.route({
|
|
|
285
1850
|
successDescription: "The project has been created successfully"
|
|
286
1851
|
}).errors({
|
|
287
1852
|
NOT_FOUND: {},
|
|
288
|
-
|
|
1853
|
+
FORBIDDEN: {}
|
|
289
1854
|
}).input(z.object({
|
|
290
1855
|
teamId: z.string().optional(),
|
|
291
1856
|
name: z.string().trim().min(1).max(100),
|
|
@@ -325,7 +1890,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
325
1890
|
isSecret: z.boolean(),
|
|
326
1891
|
createdAt: z.coerce.date()
|
|
327
1892
|
});
|
|
328
|
-
const listEnvironmentVariablesContractV1 =
|
|
1893
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
329
1894
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
330
1895
|
method: "GET",
|
|
331
1896
|
summary: "List environment variables",
|
|
@@ -333,37 +1898,31 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
333
1898
|
tags: ["environments"],
|
|
334
1899
|
successDescription: "The list of environment variables"
|
|
335
1900
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
336
|
-
const createEnvironmentVariablesContractV1 =
|
|
1901
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
337
1902
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
338
1903
|
method: "POST",
|
|
339
1904
|
summary: "Add environment variables",
|
|
340
1905
|
description: "Add one or more environment variables to an environment",
|
|
341
1906
|
tags: ["environments"],
|
|
342
1907
|
successDescription: "The environment variables have been added successfully"
|
|
343
|
-
}).errors({
|
|
344
|
-
NOT_FOUND: {},
|
|
345
|
-
BAD_REQUEST: {}
|
|
346
|
-
}).input(z.object({
|
|
1908
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
347
1909
|
environmentId: z.string().describe("The ID of the environment"),
|
|
348
1910
|
environmentVariables: environmentVariablesSchema
|
|
349
1911
|
})).output(z.object({ success: z.literal(true) }));
|
|
350
|
-
const updateEnvironmentVariableContractV1 =
|
|
1912
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
351
1913
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
352
1914
|
method: "PATCH",
|
|
353
1915
|
summary: "Update an environment variable",
|
|
354
1916
|
description: "Update an environment variable by ID",
|
|
355
1917
|
tags: ["environments"],
|
|
356
1918
|
successDescription: "The environment variable has been updated successfully"
|
|
357
|
-
}).errors({
|
|
358
|
-
NOT_FOUND: {},
|
|
359
|
-
BAD_REQUEST: {}
|
|
360
|
-
}).input(z.object({
|
|
1919
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
361
1920
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
362
1921
|
key: environmentVariableSchema.shape.key,
|
|
363
1922
|
value: environmentVariableSchema.shape.value.optional(),
|
|
364
|
-
isSecret: environmentVariableSchema.shape.isSecret
|
|
1923
|
+
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
365
1924
|
})).output(z.object({ success: z.literal(true) }));
|
|
366
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1925
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
367
1926
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
368
1927
|
method: "DELETE",
|
|
369
1928
|
summary: "Delete an environment variable",
|
|
@@ -371,15 +1930,15 @@ const deleteEnvironmentVariableContractV1 = oc.route({
|
|
|
371
1930
|
tags: ["environments"],
|
|
372
1931
|
successDescription: "The environment variable has been deleted successfully"
|
|
373
1932
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
374
|
-
const deleteProjectContractV1 =
|
|
375
|
-
path: "/v1/projects
|
|
1933
|
+
const deleteProjectContractV1 = base.route({
|
|
1934
|
+
path: "/v1/projects/{projectId}",
|
|
376
1935
|
method: "DELETE",
|
|
377
1936
|
summary: "Delete a project",
|
|
378
1937
|
description: "Delete a project and all its environments",
|
|
379
1938
|
tags: ["projects"],
|
|
380
1939
|
successDescription: "The project has been deleted successfully"
|
|
381
1940
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
382
|
-
const updateProjectContractV1 =
|
|
1941
|
+
const updateProjectContractV1 = base.route({
|
|
383
1942
|
path: "/v1/projects/{projectId}",
|
|
384
1943
|
method: "PATCH",
|
|
385
1944
|
summary: "Update a project",
|
|
@@ -388,13 +1947,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
388
1947
|
successDescription: "The project has been updated successfully"
|
|
389
1948
|
}).errors({
|
|
390
1949
|
NOT_FOUND: {},
|
|
391
|
-
|
|
1950
|
+
FORBIDDEN: {}
|
|
392
1951
|
}).input(z.object({
|
|
393
1952
|
projectId: z.string().describe("The ID of the project"),
|
|
394
1953
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
395
1954
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
396
1955
|
})).output(projectOutputSchema);
|
|
397
|
-
const deployEnvironmentContractV1 =
|
|
1956
|
+
const deployEnvironmentContractV1 = base.route({
|
|
398
1957
|
path: "/v1/environments/{environmentId}/deploy",
|
|
399
1958
|
method: "POST",
|
|
400
1959
|
summary: "Deploy an environment",
|
|
@@ -403,24 +1962,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
403
1962
|
successDescription: "The environment has been deployed successfully"
|
|
404
1963
|
}).errors({
|
|
405
1964
|
NOT_FOUND: {},
|
|
406
|
-
|
|
1965
|
+
CONFLICT: {}
|
|
407
1966
|
}).input(z.object({
|
|
408
1967
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
409
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1968
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1969
|
+
settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
|
|
410
1970
|
})).output(deploymentSchema);
|
|
411
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1971
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
412
1972
|
path: "/v1/deployments/upload",
|
|
413
1973
|
method: "POST",
|
|
414
1974
|
summary: "Upload deployment artifacts",
|
|
415
1975
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
416
1976
|
tags: ["deployments"],
|
|
417
1977
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
418
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1978
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
419
1979
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
420
1980
|
token: z.string().describe("Token to identify the source archive"),
|
|
421
1981
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
422
1982
|
}));
|
|
423
|
-
const listDeploymentsContractV1 =
|
|
1983
|
+
const listDeploymentsContractV1 = base.route({
|
|
424
1984
|
path: "/v1/projects/{projectId}/deployments",
|
|
425
1985
|
method: "GET",
|
|
426
1986
|
summary: "List project deployments",
|
|
@@ -432,7 +1992,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
432
1992
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
433
1993
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
434
1994
|
})).output(z.array(deploymentSchema));
|
|
435
|
-
const getDeploymentContractV1 =
|
|
1995
|
+
const getDeploymentContractV1 = base.route({
|
|
436
1996
|
path: "/v1/deployments/{deploymentId}",
|
|
437
1997
|
method: "GET",
|
|
438
1998
|
summary: "Get a deployment",
|
|
@@ -440,20 +2000,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
440
2000
|
tags: ["deployments"],
|
|
441
2001
|
successDescription: "The deployment details"
|
|
442
2002
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
443
|
-
const
|
|
2003
|
+
const logEntrySchema = z.object({
|
|
2004
|
+
timestamp: z.coerce.date(),
|
|
2005
|
+
type: z.enum([
|
|
2006
|
+
"START",
|
|
2007
|
+
"END",
|
|
2008
|
+
"INFO",
|
|
2009
|
+
"ERROR",
|
|
2010
|
+
"WARNING",
|
|
2011
|
+
"DEBUG"
|
|
2012
|
+
]),
|
|
2013
|
+
requestId: z.string(),
|
|
2014
|
+
content: z.string().optional(),
|
|
2015
|
+
method: z.string().optional(),
|
|
2016
|
+
durationInMs: z.number().optional()
|
|
2017
|
+
});
|
|
2018
|
+
const getLogsContractV1 = base.route({
|
|
444
2019
|
path: "/v1/environments/{environmentId}/logs",
|
|
445
2020
|
method: "GET",
|
|
446
2021
|
summary: "Get logs",
|
|
447
2022
|
description: "Get logs for an environment",
|
|
448
2023
|
tags: ["environments"],
|
|
449
2024
|
successDescription: "The logs"
|
|
450
|
-
}).errors({
|
|
451
|
-
NOT_FOUND: {},
|
|
452
|
-
BAD_REQUEST: {}
|
|
453
|
-
}).input(z.object({
|
|
2025
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
454
2026
|
environmentId: z.string().describe("The ID of the environment"),
|
|
455
|
-
since:
|
|
456
|
-
until:
|
|
2027
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2028
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
457
2029
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
458
2030
|
level: z.array(z.enum([
|
|
459
2031
|
"INFO",
|
|
@@ -464,24 +2036,28 @@ const getLogsContractV1 = oc.route({
|
|
|
464
2036
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
465
2037
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
466
2038
|
})).output(z.object({
|
|
467
|
-
logs: z.array(
|
|
468
|
-
timestamp: z.coerce.date(),
|
|
469
|
-
type: z.enum([
|
|
470
|
-
"START",
|
|
471
|
-
"END",
|
|
472
|
-
"INFO",
|
|
473
|
-
"ERROR",
|
|
474
|
-
"WARNING",
|
|
475
|
-
"DEBUG"
|
|
476
|
-
]),
|
|
477
|
-
requestId: z.string(),
|
|
478
|
-
content: z.string().optional(),
|
|
479
|
-
method: z.string().optional(),
|
|
480
|
-
durationInMs: z.number().optional()
|
|
481
|
-
})),
|
|
2039
|
+
logs: z.array(logEntrySchema),
|
|
482
2040
|
nextToken: z.string().nullable()
|
|
483
2041
|
}));
|
|
484
|
-
const
|
|
2042
|
+
const getLatestLogsContractV1 = base.route({
|
|
2043
|
+
path: "/v1/environments/{environmentId}/latest-logs",
|
|
2044
|
+
method: "GET",
|
|
2045
|
+
summary: "Get latest logs",
|
|
2046
|
+
description: "Get the N most recent logs for an environment",
|
|
2047
|
+
tags: ["environments"],
|
|
2048
|
+
successDescription: "The latest logs"
|
|
2049
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2050
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2051
|
+
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
2052
|
+
level: z.array(z.enum([
|
|
2053
|
+
"INFO",
|
|
2054
|
+
"ERROR",
|
|
2055
|
+
"WARNING",
|
|
2056
|
+
"DEBUG"
|
|
2057
|
+
])).optional().describe("Filter by log level"),
|
|
2058
|
+
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
2059
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
2060
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
485
2061
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
486
2062
|
method: "GET",
|
|
487
2063
|
summary: "Get deployment logs",
|
|
@@ -508,22 +2084,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
508
2084
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
509
2085
|
task_count: z.array(analyticsDataPointSchema)
|
|
510
2086
|
});
|
|
511
|
-
const getProjectAnalyticsContractV1 =
|
|
2087
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
512
2088
|
path: "/v1/analytics/{projectId}",
|
|
513
2089
|
method: "GET",
|
|
514
2090
|
summary: "Get project analytics",
|
|
515
2091
|
description: "Get analytics data for a project over a time range",
|
|
516
2092
|
tags: ["analytics"],
|
|
517
2093
|
successDescription: "The project analytics data"
|
|
518
|
-
}).errors({
|
|
519
|
-
NOT_FOUND: {},
|
|
520
|
-
BAD_REQUEST: {}
|
|
521
|
-
}).input(z.object({
|
|
2094
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
522
2095
|
projectId: z.string().describe("The ID of the project"),
|
|
523
2096
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
524
2097
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
525
2098
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
526
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2099
|
+
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 26784e5, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => isValidIanaTimeZone(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
527
2100
|
metadata: z.object({
|
|
528
2101
|
startTimestamp: z.number(),
|
|
529
2102
|
endTimestamp: z.number(),
|
|
@@ -533,7 +2106,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
533
2106
|
}),
|
|
534
2107
|
timeSeries: analyticsTimeSeriesSchema
|
|
535
2108
|
}));
|
|
536
|
-
const
|
|
2109
|
+
const paginatedInsightsInputShape = {
|
|
2110
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2111
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2112
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2113
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2114
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2115
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2116
|
+
};
|
|
2117
|
+
const listIntentsContractV1 = base.route({
|
|
2118
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2119
|
+
method: "GET",
|
|
2120
|
+
summary: "List intents",
|
|
2121
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2122
|
+
tags: ["insights"],
|
|
2123
|
+
successDescription: "The grouped user intents"
|
|
2124
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2125
|
+
...paginatedInsightsInputShape,
|
|
2126
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2127
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2128
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2129
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2130
|
+
})).output(z.object({
|
|
2131
|
+
intents: z.array(z.object({
|
|
2132
|
+
id: z.string(),
|
|
2133
|
+
intentIds: z.array(z.string()).min(1),
|
|
2134
|
+
environmentId: z.string(),
|
|
2135
|
+
message: z.string(),
|
|
2136
|
+
toolName: z.string(),
|
|
2137
|
+
createdAt: z.coerce.date(),
|
|
2138
|
+
occurrenceCount: z.number().int().positive(),
|
|
2139
|
+
clientName: z.string().nullable(),
|
|
2140
|
+
clientId: z.string().nullable(),
|
|
2141
|
+
categories: z.array(z.object({
|
|
2142
|
+
id: z.string(),
|
|
2143
|
+
name: z.string(),
|
|
2144
|
+
color: intentCategoryColorSchema
|
|
2145
|
+
}))
|
|
2146
|
+
})),
|
|
2147
|
+
totalCount: z.number().int().nonnegative()
|
|
2148
|
+
}));
|
|
2149
|
+
const listFeedbacksContractV1 = base.route({
|
|
2150
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2151
|
+
method: "GET",
|
|
2152
|
+
summary: "List feedbacks",
|
|
2153
|
+
description: "List user feedback for an environment over a time range",
|
|
2154
|
+
tags: ["insights"],
|
|
2155
|
+
successDescription: "The user feedback"
|
|
2156
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2157
|
+
...paginatedInsightsInputShape,
|
|
2158
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2159
|
+
})).output(z.object({
|
|
2160
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2161
|
+
totalCount: z.number().int().nonnegative()
|
|
2162
|
+
}));
|
|
2163
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2164
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2165
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2166
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2167
|
+
method: "GET",
|
|
2168
|
+
summary: "List intent categories",
|
|
2169
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2170
|
+
tags: ["insights"],
|
|
2171
|
+
successDescription: "The intent categories"
|
|
2172
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2173
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2174
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2175
|
+
method: "POST",
|
|
2176
|
+
summary: "Create an intent category",
|
|
2177
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2178
|
+
tags: ["insights"],
|
|
2179
|
+
successDescription: "The created intent category"
|
|
2180
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2181
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2182
|
+
name: intentCategoryNameSchema,
|
|
2183
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2184
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2185
|
+
})).output(intentCategorySchema);
|
|
2186
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2187
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2188
|
+
method: "PATCH",
|
|
2189
|
+
summary: "Update an intent category",
|
|
2190
|
+
description: "Rename or recolor an intent category",
|
|
2191
|
+
tags: ["insights"],
|
|
2192
|
+
successDescription: "The updated intent category"
|
|
2193
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2194
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2195
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2196
|
+
name: intentCategoryNameSchema.optional(),
|
|
2197
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2198
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2199
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2200
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2201
|
+
method: "DELETE",
|
|
2202
|
+
summary: "Delete an intent category",
|
|
2203
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2204
|
+
tags: ["insights"],
|
|
2205
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2206
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2207
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2208
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2209
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2210
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2211
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2212
|
+
method: "POST",
|
|
2213
|
+
summary: "Link an intent category",
|
|
2214
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2215
|
+
tags: ["insights"],
|
|
2216
|
+
successDescription: "The intents have been linked successfully"
|
|
2217
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2218
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2219
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2220
|
+
intentIds: categorizableIntentIdsSchema
|
|
2221
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2222
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2223
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2224
|
+
method: "POST",
|
|
2225
|
+
summary: "Unlink an intent category",
|
|
2226
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2227
|
+
tags: ["insights"],
|
|
2228
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2229
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2230
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2231
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2232
|
+
intentIds: categorizableIntentIdsSchema
|
|
2233
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2234
|
+
const listTeamsContractV1 = base.route({
|
|
537
2235
|
path: "/v1/teams",
|
|
538
2236
|
method: "GET",
|
|
539
2237
|
summary: "List teams",
|
|
@@ -546,28 +2244,40 @@ const listTeamsContractV1 = oc.route({
|
|
|
546
2244
|
createdAt: z.coerce.date(),
|
|
547
2245
|
hasStripeAccount: z.boolean()
|
|
548
2246
|
})));
|
|
549
|
-
const
|
|
2247
|
+
const getTeamUsageContractV1 = base.route({
|
|
2248
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2249
|
+
method: "GET",
|
|
2250
|
+
summary: "Get team usage",
|
|
2251
|
+
description: "Get the MCP request usage of a team for its current billing window. A team that has made no request in the window reports zero.",
|
|
2252
|
+
tags: ["teams"],
|
|
2253
|
+
successDescription: "The current billing window usage"
|
|
2254
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2255
|
+
teamId: z.string(),
|
|
2256
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2257
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2258
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2259
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2260
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2261
|
+
}));
|
|
2262
|
+
const getTunnelTicketContractV1 = base.route({
|
|
550
2263
|
path: "/v1/tunnels/ticket",
|
|
551
2264
|
method: "GET",
|
|
552
2265
|
summary: "Get a tunnel ticket",
|
|
553
2266
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
554
2267
|
tags: ["tunnels"],
|
|
555
2268
|
successDescription: "The tunnel ticket"
|
|
556
|
-
}).output(z.object({
|
|
2269
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
557
2270
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
558
2271
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
559
2272
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
560
2273
|
}));
|
|
561
|
-
const publishServerContractV1 =
|
|
2274
|
+
const publishServerContractV1 = base.route({
|
|
562
2275
|
path: "/v1/distribution/publish",
|
|
563
2276
|
method: "POST",
|
|
564
2277
|
summary: "Publish a server to the MCP registry",
|
|
565
2278
|
tags: ["distribution"],
|
|
566
2279
|
successDescription: "The server has been published successfully"
|
|
567
|
-
}).errors({
|
|
568
|
-
NOT_FOUND: {},
|
|
569
|
-
BAD_REQUEST: {}
|
|
570
|
-
}).input(z.object({
|
|
2280
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
571
2281
|
projectId: z.string(),
|
|
572
2282
|
domain: z.string(),
|
|
573
2283
|
title: z.string().min(1).max(100),
|
|
@@ -576,53 +2286,153 @@ const publishServerContractV1 = oc.route({
|
|
|
576
2286
|
iconSrc: z.url().max(255).optional(),
|
|
577
2287
|
dryRun: z.boolean().optional()
|
|
578
2288
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
579
|
-
const getServerInfoContractV1 =
|
|
2289
|
+
const getServerInfoContractV1 = base.route({
|
|
580
2290
|
path: "/v1/distribution/get",
|
|
581
2291
|
method: "GET",
|
|
582
2292
|
summary: "Get server info",
|
|
583
2293
|
description: "Get info about a server",
|
|
584
2294
|
tags: ["distribution"],
|
|
585
2295
|
successDescription: "The server info"
|
|
586
|
-
}).errors({
|
|
587
|
-
NOT_FOUND: {},
|
|
588
|
-
BAD_REQUEST: {}
|
|
589
|
-
}).input(z.object({
|
|
2296
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
590
2297
|
projectId: z.string(),
|
|
591
2298
|
domain: z.string()
|
|
592
2299
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
593
|
-
const
|
|
594
|
-
|
|
2300
|
+
const playgroundServerMetadataOutputSchema = z.object({
|
|
2301
|
+
name: z.string(),
|
|
2302
|
+
description: z.string(),
|
|
2303
|
+
headers: z.array(z.object({
|
|
2304
|
+
name: z.string(),
|
|
2305
|
+
description: z.string(),
|
|
2306
|
+
isRequired: z.boolean(),
|
|
2307
|
+
isSecret: z.boolean()
|
|
2308
|
+
})),
|
|
2309
|
+
examplePrompts: z.array(playgroundExamplePromptSchema)
|
|
2310
|
+
});
|
|
2311
|
+
const playgroundOutputSchema = z.object({
|
|
2312
|
+
isPlaygroundEnabled: z.boolean(),
|
|
2313
|
+
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
2314
|
+
});
|
|
2315
|
+
const getPlaygroundContractV1 = base.route({
|
|
2316
|
+
path: "/v1/environments/{environmentId}/playground",
|
|
2317
|
+
method: "GET",
|
|
2318
|
+
summary: "Get playground configuration",
|
|
2319
|
+
description: "Get the playground configuration for an environment",
|
|
2320
|
+
tags: ["environments"],
|
|
2321
|
+
successDescription: "The playground configuration"
|
|
2322
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
2323
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
2324
|
+
path: "/v1/environments/{environmentId}/playground",
|
|
2325
|
+
method: "PUT",
|
|
2326
|
+
summary: "Update playground configuration",
|
|
2327
|
+
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
2328
|
+
tags: ["environments"],
|
|
2329
|
+
successDescription: "The updated playground configuration"
|
|
2330
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2331
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2332
|
+
isPlaygroundEnabled: z.boolean().optional(),
|
|
2333
|
+
name: z.string().min(1).max(100).optional(),
|
|
2334
|
+
description: z.string().min(1).max(500).optional(),
|
|
2335
|
+
headers: z.array(playgroundHeaderSchema).optional(),
|
|
2336
|
+
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
2337
|
+
})).output(playgroundOutputSchema);
|
|
2338
|
+
const createBeaconContractV1 = base.route({
|
|
2339
|
+
path: "/v1/beacon/audits",
|
|
595
2340
|
method: "POST",
|
|
596
|
-
summary: "Create a beacon
|
|
597
|
-
description: "
|
|
2341
|
+
summary: "Create a beacon audit",
|
|
2342
|
+
description: "Audit an MCP server for spec compliance and AI client compatibility",
|
|
598
2343
|
tags: ["beacon"],
|
|
599
|
-
successDescription: "The
|
|
2344
|
+
successDescription: "The audit has been created"
|
|
600
2345
|
}).errors({
|
|
601
2346
|
NOT_FOUND: {},
|
|
602
|
-
|
|
2347
|
+
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
603
2348
|
}).input(z.object({
|
|
604
|
-
targetUrl: z.
|
|
605
|
-
teamId: z.string().optional().describe("The team ID to associate the
|
|
606
|
-
projectId: z.string().optional().describe("The project ID to associate the
|
|
2349
|
+
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
2350
|
+
teamId: z.string().optional().describe("The team ID to associate the audit with"),
|
|
2351
|
+
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
2352
|
+
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
607
2353
|
})).output(z.object({ id: z.string() }));
|
|
608
|
-
const getBeaconContractV1 =
|
|
609
|
-
path: "/v1/beacon/
|
|
2354
|
+
const getBeaconContractV1 = base.route({
|
|
2355
|
+
path: "/v1/beacon/audits/{auditId}",
|
|
610
2356
|
method: "GET",
|
|
611
|
-
summary: "Get a beacon
|
|
612
|
-
description: "Get a beacon
|
|
2357
|
+
summary: "Get a beacon audit",
|
|
2358
|
+
description: "Get a beacon audit by ID, including the report if completed",
|
|
613
2359
|
tags: ["beacon"],
|
|
614
|
-
successDescription: "The
|
|
615
|
-
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2360
|
+
successDescription: "The audit details"
|
|
2361
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ auditId: z.string().describe("The ID of the audit") })).output(z.object({
|
|
616
2362
|
id: z.string(),
|
|
617
2363
|
targetUrl: z.string(),
|
|
618
|
-
status:
|
|
2364
|
+
status: auditStatusSchema,
|
|
619
2365
|
durationMs: z.number().nullable(),
|
|
620
2366
|
createdAt: z.coerce.date(),
|
|
621
|
-
report:
|
|
2367
|
+
report: auditReportWithScreenshotsSchema.nullable()
|
|
622
2368
|
}));
|
|
2369
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2370
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2371
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2372
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2373
|
+
const createSubmissionContractV1 = base.route({
|
|
2374
|
+
path: "/v1/submissions",
|
|
2375
|
+
method: "POST",
|
|
2376
|
+
summary: "Create a submission package",
|
|
2377
|
+
description: "Create a submission package for an environment. Alpic reads the environment's live MCP server and prefills every field it can infer, so the response already carries the populated package. The environment must have a successful deployment and must not require authentication.",
|
|
2378
|
+
tags: ["submissions"],
|
|
2379
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2380
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2381
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2382
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2383
|
+
})).output(submissionSchema);
|
|
2384
|
+
const listSubmissionsContractV1 = base.route({
|
|
2385
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2386
|
+
method: "GET",
|
|
2387
|
+
summary: "List submission packages",
|
|
2388
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2389
|
+
tags: ["submissions"],
|
|
2390
|
+
successDescription: "The list of submission packages"
|
|
2391
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2392
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2393
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2394
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2395
|
+
})).output(z.array(submissionSchema));
|
|
2396
|
+
const getSubmissionContractV1 = base.route({
|
|
2397
|
+
path: "/v1/submissions/{submissionId}",
|
|
2398
|
+
method: "GET",
|
|
2399
|
+
summary: "Get a submission package",
|
|
2400
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2401
|
+
tags: ["submissions"],
|
|
2402
|
+
successDescription: "The submission package"
|
|
2403
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2404
|
+
const updateSubmissionContractV1 = base.route({
|
|
2405
|
+
path: "/v1/submissions/{submissionId}",
|
|
2406
|
+
method: "PUT",
|
|
2407
|
+
summary: "Update a submission package",
|
|
2408
|
+
description: "Update the form data of a submission package. Only the fields you send are changed; the rest are left as they are. Unknown field names are rejected rather than ignored, so a typo fails the call. `platform` must match the package's own platform.",
|
|
2409
|
+
tags: ["submissions"],
|
|
2410
|
+
successDescription: "The updated submission package"
|
|
2411
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2412
|
+
submissionId: submissionIdSchema,
|
|
2413
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2414
|
+
formData: claudeSubmissionUpdateSchema
|
|
2415
|
+
}), z.object({
|
|
2416
|
+
submissionId: submissionIdSchema,
|
|
2417
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2418
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2419
|
+
})])).output(submissionSchema);
|
|
623
2420
|
const contract = {
|
|
624
|
-
teams: {
|
|
2421
|
+
teams: {
|
|
2422
|
+
list: { v1: listTeamsContractV1 },
|
|
2423
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2424
|
+
},
|
|
625
2425
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2426
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2427
|
+
intentCategories: {
|
|
2428
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2429
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2430
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2431
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2432
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2433
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2434
|
+
},
|
|
2435
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
626
2436
|
deployments: {
|
|
627
2437
|
list: { v1: listDeploymentsContractV1 },
|
|
628
2438
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -632,8 +2442,10 @@ const contract = {
|
|
|
632
2442
|
environments: {
|
|
633
2443
|
create: { v1: createEnvironmentContractV1 },
|
|
634
2444
|
get: { v1: getEnvironmentContractV1 },
|
|
2445
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
635
2446
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
636
|
-
getLogs: { v1: getLogsContractV1 }
|
|
2447
|
+
getLogs: { v1: getLogsContractV1 },
|
|
2448
|
+
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
637
2449
|
},
|
|
638
2450
|
environmentVariables: {
|
|
639
2451
|
list: { v1: listEnvironmentVariablesContractV1 },
|
|
@@ -648,6 +2460,10 @@ const contract = {
|
|
|
648
2460
|
create: { v1: createProjectContractV1 },
|
|
649
2461
|
delete: { v1: deleteProjectContractV1 }
|
|
650
2462
|
},
|
|
2463
|
+
playground: {
|
|
2464
|
+
get: { v1: getPlaygroundContractV1 },
|
|
2465
|
+
upsert: { v1: upsertPlaygroundContractV1 }
|
|
2466
|
+
},
|
|
651
2467
|
tunnels: { getTicket: { v1: getTunnelTicketContractV1 } },
|
|
652
2468
|
distribution: {
|
|
653
2469
|
publish: { v1: publishServerContractV1 },
|
|
@@ -656,7 +2472,39 @@ const contract = {
|
|
|
656
2472
|
beacon: {
|
|
657
2473
|
create: { v1: createBeaconContractV1 },
|
|
658
2474
|
get: { v1: getBeaconContractV1 }
|
|
2475
|
+
},
|
|
2476
|
+
submissions: {
|
|
2477
|
+
create: { v1: createSubmissionContractV1 },
|
|
2478
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2479
|
+
get: { v1: getSubmissionContractV1 },
|
|
2480
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2481
|
+
}
|
|
2482
|
+
};
|
|
2483
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2484
|
+
const contractForDocs = {
|
|
2485
|
+
...contract,
|
|
2486
|
+
deployments: deploymentsForDocs
|
|
2487
|
+
};
|
|
2488
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2489
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2490
|
+
info: {
|
|
2491
|
+
title: "Alpic API",
|
|
2492
|
+
version: "1.0.0"
|
|
2493
|
+
},
|
|
2494
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2495
|
+
security: [{ bearerAuth: [] }],
|
|
2496
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2497
|
+
type: "http",
|
|
2498
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2499
|
+
scheme: "bearer"
|
|
2500
|
+
} } },
|
|
2501
|
+
commonSchemas: {
|
|
2502
|
+
Submission: { schema: submissionSchema },
|
|
2503
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2504
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2505
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2506
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
659
2507
|
}
|
|
660
2508
|
};
|
|
661
2509
|
//#endregion
|
|
662
|
-
export {
|
|
2510
|
+
export { AI_PLATFORMS, AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, OPENAPI_DOC_OPTIONS, PLATFORM_LABELS, buildSettingsSchema, chatgptSubmissionUpdateSchema, claudeSubmissionUpdateSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|