@alpic-ai/api 0.0.0-dev.ge2111aa → 0.0.0-dev.ge3cead0
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 +19 -14
- package/dist/index.mjs +351 -41
- package/package.json +1 -10
package/dist/index.d.mts
CHANGED
|
@@ -212,7 +212,7 @@ declare const contract: {
|
|
|
212
212
|
name: z.ZodString;
|
|
213
213
|
sourceBranch: z.ZodNullable<z.ZodString>;
|
|
214
214
|
mcpServerUrl: z.ZodString;
|
|
215
|
-
domains: z.ZodArray<z.
|
|
215
|
+
domains: z.ZodArray<z.ZodCustomStringFormat<"hostname">>;
|
|
216
216
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
217
217
|
projectId: z.ZodString;
|
|
218
218
|
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
@@ -831,6 +831,9 @@ declare const contract: {
|
|
|
831
831
|
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
832
832
|
NOT_FOUND: {};
|
|
833
833
|
BAD_REQUEST: {};
|
|
834
|
+
DNS_RESOLUTION_FAILED: {
|
|
835
|
+
status: number;
|
|
836
|
+
};
|
|
834
837
|
}>, Record<never, never>>;
|
|
835
838
|
};
|
|
836
839
|
get: {
|
|
@@ -935,7 +938,22 @@ declare const platformSchema: z.ZodEnum<{
|
|
|
935
938
|
type Platform = z.infer<typeof platformSchema>;
|
|
936
939
|
declare const PLATFORM_LABELS: Record<Platform, string>;
|
|
937
940
|
//#endregion
|
|
941
|
+
//#region ../domains/src/projects/schemas.d.ts
|
|
942
|
+
declare const runtimeSchema: z.ZodEnum<{
|
|
943
|
+
"python3.13": "python3.13";
|
|
944
|
+
"python3.14": "python3.14";
|
|
945
|
+
node22: "node22";
|
|
946
|
+
node24: "node24";
|
|
947
|
+
}>;
|
|
948
|
+
declare const transportSchema: z.ZodEnum<{
|
|
949
|
+
stdio: "stdio";
|
|
950
|
+
sse: "sse";
|
|
951
|
+
streamablehttp: "streamablehttp";
|
|
952
|
+
}>;
|
|
953
|
+
//#endregion
|
|
938
954
|
//#region src/schemas.d.ts
|
|
955
|
+
type Runtime = z.infer<typeof runtimeSchema>;
|
|
956
|
+
type Transport = z.infer<typeof transportSchema>;
|
|
939
957
|
declare const environmentVariableSchema: z.ZodObject<{
|
|
940
958
|
key: z.ZodString;
|
|
941
959
|
value: z.ZodString;
|
|
@@ -957,19 +975,6 @@ declare const buildSettingsSchema: z.ZodObject<{
|
|
|
957
975
|
buildOutputDir: z.ZodOptional<z.ZodString>;
|
|
958
976
|
startCommand: z.ZodOptional<z.ZodString>;
|
|
959
977
|
}, z.core.$strip>;
|
|
960
|
-
declare const runtimeSchema: z.ZodEnum<{
|
|
961
|
-
"python3.13": "python3.13";
|
|
962
|
-
"python3.14": "python3.14";
|
|
963
|
-
node22: "node22";
|
|
964
|
-
node24: "node24";
|
|
965
|
-
}>;
|
|
966
|
-
type Runtime = z.infer<typeof runtimeSchema>;
|
|
967
|
-
declare const transportSchema: z.ZodEnum<{
|
|
968
|
-
stdio: "stdio";
|
|
969
|
-
sse: "sse";
|
|
970
|
-
streamablehttp: "streamablehttp";
|
|
971
|
-
}>;
|
|
972
|
-
type Transport = z.infer<typeof transportSchema>;
|
|
973
978
|
declare const playgroundHeaderSchema: z.ZodObject<{
|
|
974
979
|
name: z.ZodString;
|
|
975
980
|
description: z.ZodString;
|
package/dist/index.mjs
CHANGED
|
@@ -71,7 +71,7 @@ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreen
|
|
|
71
71
|
chatgpt: widgetScreenshotSchema.optional(),
|
|
72
72
|
claudeai: widgetScreenshotSchema.optional()
|
|
73
73
|
}) });
|
|
74
|
-
z.enum([
|
|
74
|
+
const deploymentStatusSchema$1 = z.enum([
|
|
75
75
|
"ongoing",
|
|
76
76
|
"deployed",
|
|
77
77
|
"failed",
|
|
@@ -81,6 +81,51 @@ z.object({
|
|
|
81
81
|
timestamp: z.coerce.date().optional(),
|
|
82
82
|
content: z.string().optional()
|
|
83
83
|
});
|
|
84
|
+
const deploymentSummarySchema = z.object({
|
|
85
|
+
id: z.string(),
|
|
86
|
+
status: deploymentStatusSchema$1,
|
|
87
|
+
sourceBucket: z.string().nullable(),
|
|
88
|
+
sourceObjectKey: z.string().nullable(),
|
|
89
|
+
sourceRef: z.string().nullable(),
|
|
90
|
+
sourceCommitId: z.string().nullable(),
|
|
91
|
+
sourceCommitMessage: z.string().nullable(),
|
|
92
|
+
environmentId: z.string(),
|
|
93
|
+
authorUsername: z.string().nullable(),
|
|
94
|
+
authorAvatarUrl: z.string().nullable(),
|
|
95
|
+
startedAt: z.coerce.date().nullable(),
|
|
96
|
+
completedAt: z.coerce.date().nullable(),
|
|
97
|
+
isCurrent: z.boolean().optional(),
|
|
98
|
+
createdAt: z.coerce.date(),
|
|
99
|
+
updatedAt: z.coerce.date()
|
|
100
|
+
});
|
|
101
|
+
const allowedPlatformSchema = platformSchema;
|
|
102
|
+
const environmentDomainSchema = z.object({
|
|
103
|
+
domain: z.string(),
|
|
104
|
+
status: z.enum([
|
|
105
|
+
"ongoing",
|
|
106
|
+
"deployed",
|
|
107
|
+
"failed"
|
|
108
|
+
]),
|
|
109
|
+
createdAt: z.coerce.date(),
|
|
110
|
+
updatedAt: z.coerce.date()
|
|
111
|
+
});
|
|
112
|
+
const environmentSchema$1 = z.object({
|
|
113
|
+
id: z.string(),
|
|
114
|
+
name: z.string(),
|
|
115
|
+
sourceBranch: z.string().nullable(),
|
|
116
|
+
mcpServerUrl: z.string(),
|
|
117
|
+
activeDeployment: deploymentSummarySchema.optional(),
|
|
118
|
+
latestDeployment: deploymentSummarySchema.optional(),
|
|
119
|
+
openaiAppsChallenge: z.string().nullable().optional(),
|
|
120
|
+
isPlaygroundEnabled: z.boolean(),
|
|
121
|
+
isIpWhitelistEnabled: z.boolean(),
|
|
122
|
+
ipAllowlist: z.array(z.string()).nullable(),
|
|
123
|
+
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
124
|
+
projectId: z.string(),
|
|
125
|
+
createdAt: z.coerce.date(),
|
|
126
|
+
updatedAt: z.coerce.date()
|
|
127
|
+
});
|
|
128
|
+
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
84
129
|
z.object({
|
|
85
130
|
id: z.string(),
|
|
86
131
|
createdAt: z.coerce.date(),
|
|
@@ -92,6 +137,86 @@ z.object({
|
|
|
92
137
|
content: z.string(),
|
|
93
138
|
source: z.enum(["model", "user"])
|
|
94
139
|
});
|
|
140
|
+
const intentCategoryColorSchema = z.enum([
|
|
141
|
+
"red",
|
|
142
|
+
"orange",
|
|
143
|
+
"yellow",
|
|
144
|
+
"green",
|
|
145
|
+
"blue",
|
|
146
|
+
"purple",
|
|
147
|
+
"pink",
|
|
148
|
+
"gray"
|
|
149
|
+
]);
|
|
150
|
+
intentCategoryColorSchema.options;
|
|
151
|
+
const intentCategorySchema = z.object({
|
|
152
|
+
id: z.string(),
|
|
153
|
+
createdAt: z.coerce.date(),
|
|
154
|
+
environmentId: z.string(),
|
|
155
|
+
name: z.string(),
|
|
156
|
+
color: intentCategoryColorSchema
|
|
157
|
+
});
|
|
158
|
+
z.object({
|
|
159
|
+
id: z.string(),
|
|
160
|
+
name: z.string(),
|
|
161
|
+
color: intentCategoryColorSchema,
|
|
162
|
+
intentCount: z.number().int().nonnegative()
|
|
163
|
+
});
|
|
164
|
+
z.object({
|
|
165
|
+
id: z.string(),
|
|
166
|
+
createdAt: z.coerce.date(),
|
|
167
|
+
environmentId: z.string(),
|
|
168
|
+
toolName: z.string(),
|
|
169
|
+
message: z.string(),
|
|
170
|
+
categories: z.array(intentCategorySchema)
|
|
171
|
+
});
|
|
172
|
+
const signalCategorySchema = z.object({
|
|
173
|
+
id: z.string(),
|
|
174
|
+
name: z.string(),
|
|
175
|
+
color: intentCategoryColorSchema
|
|
176
|
+
});
|
|
177
|
+
z.discriminatedUnion("kind", [
|
|
178
|
+
z.object({
|
|
179
|
+
kind: z.literal("new"),
|
|
180
|
+
category: signalCategorySchema,
|
|
181
|
+
currentCount: z.number().int().nonnegative(),
|
|
182
|
+
currentShare: z.number()
|
|
183
|
+
}),
|
|
184
|
+
z.object({
|
|
185
|
+
kind: z.literal("resurging"),
|
|
186
|
+
category: signalCategorySchema,
|
|
187
|
+
currentCount: z.number().int().nonnegative(),
|
|
188
|
+
daysQuiet: z.number(),
|
|
189
|
+
currentShare: z.number()
|
|
190
|
+
}),
|
|
191
|
+
z.object({
|
|
192
|
+
kind: z.literal("spike"),
|
|
193
|
+
category: signalCategorySchema,
|
|
194
|
+
currentCount: z.number().int().nonnegative(),
|
|
195
|
+
previousCount: z.number().int().nonnegative(),
|
|
196
|
+
currentShare: z.number(),
|
|
197
|
+
previousShare: z.number(),
|
|
198
|
+
changeRatio: z.number()
|
|
199
|
+
}),
|
|
200
|
+
z.object({
|
|
201
|
+
kind: z.literal("declining"),
|
|
202
|
+
category: signalCategorySchema,
|
|
203
|
+
currentCount: z.number().int().nonnegative(),
|
|
204
|
+
previousCount: z.number().int().nonnegative(),
|
|
205
|
+
currentShare: z.number(),
|
|
206
|
+
previousShare: z.number(),
|
|
207
|
+
changeRatio: z.number()
|
|
208
|
+
})
|
|
209
|
+
]);
|
|
210
|
+
z.discriminatedUnion("kind", [z.object({
|
|
211
|
+
kind: z.literal("existing"),
|
|
212
|
+
categoryId: z.string(),
|
|
213
|
+
categoryName: z.string(),
|
|
214
|
+
intentIds: z.array(z.string())
|
|
215
|
+
}), z.object({
|
|
216
|
+
kind: z.literal("new"),
|
|
217
|
+
categoryName: z.string(),
|
|
218
|
+
intentIds: z.array(z.string())
|
|
219
|
+
})]);
|
|
95
220
|
z.object({
|
|
96
221
|
id: z.string(),
|
|
97
222
|
teamId: z.string(),
|
|
@@ -100,6 +225,93 @@ z.object({
|
|
|
100
225
|
createdAt: z.coerce.date(),
|
|
101
226
|
updatedAt: z.coerce.date()
|
|
102
227
|
});
|
|
228
|
+
z.enum([
|
|
229
|
+
"INFO",
|
|
230
|
+
"WARNING",
|
|
231
|
+
"DEBUG",
|
|
232
|
+
"ERROR"
|
|
233
|
+
]);
|
|
234
|
+
const runtimeSchema = z.enum([
|
|
235
|
+
"python3.13",
|
|
236
|
+
"python3.14",
|
|
237
|
+
"node22",
|
|
238
|
+
"node24"
|
|
239
|
+
]);
|
|
240
|
+
const transportSchema = z.enum([
|
|
241
|
+
"stdio",
|
|
242
|
+
"sse",
|
|
243
|
+
"streamablehttp"
|
|
244
|
+
]);
|
|
245
|
+
z.object({
|
|
246
|
+
id: z.string(),
|
|
247
|
+
name: z.string(),
|
|
248
|
+
teamId: z.string(),
|
|
249
|
+
sourceRepository: z.string().nullable(),
|
|
250
|
+
createdAt: z.coerce.date().optional(),
|
|
251
|
+
runtime: runtimeSchema,
|
|
252
|
+
transport: transportSchema.nullable(),
|
|
253
|
+
rootDirectory: z.string().nullable(),
|
|
254
|
+
installCommand: z.string().nullable(),
|
|
255
|
+
buildCommand: z.string().nullable(),
|
|
256
|
+
buildOutputDir: z.string().nullable(),
|
|
257
|
+
startCommand: z.string().nullable(),
|
|
258
|
+
fixedOutboundIp: z.boolean(),
|
|
259
|
+
environments: z.array(environmentWithDomainsSchema),
|
|
260
|
+
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
261
|
+
});
|
|
262
|
+
z.object({
|
|
263
|
+
domain: z.string(),
|
|
264
|
+
createdAt: z.coerce.date(),
|
|
265
|
+
status: z.enum([
|
|
266
|
+
"ongoing",
|
|
267
|
+
"deployed",
|
|
268
|
+
"failed"
|
|
269
|
+
]),
|
|
270
|
+
environment: environmentSchema$1
|
|
271
|
+
});
|
|
272
|
+
const serverFieldsSchema$1 = z.object({
|
|
273
|
+
$schema: z.string(),
|
|
274
|
+
name: z.string(),
|
|
275
|
+
description: z.string(),
|
|
276
|
+
version: z.string().optional(),
|
|
277
|
+
title: z.string().optional(),
|
|
278
|
+
websiteUrl: z.string().optional(),
|
|
279
|
+
icons: z.array(z.object({
|
|
280
|
+
src: z.string(),
|
|
281
|
+
mimeType: z.string().optional(),
|
|
282
|
+
sizes: z.array(z.string()).optional()
|
|
283
|
+
})).optional(),
|
|
284
|
+
remotes: z.array(z.object({
|
|
285
|
+
type: z.string(),
|
|
286
|
+
url: z.string().optional(),
|
|
287
|
+
headers: z.array(z.object({
|
|
288
|
+
name: z.string(),
|
|
289
|
+
description: z.string(),
|
|
290
|
+
isRequired: z.boolean().optional(),
|
|
291
|
+
isSecret: z.boolean().optional()
|
|
292
|
+
})).optional()
|
|
293
|
+
})).optional()
|
|
294
|
+
}).catchall(z.unknown());
|
|
295
|
+
z.object({
|
|
296
|
+
serverFields: serverFieldsSchema$1,
|
|
297
|
+
source: z.enum(["registry", "defaults"])
|
|
298
|
+
});
|
|
299
|
+
/**
|
|
300
|
+
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
301
|
+
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
302
|
+
*
|
|
303
|
+
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
304
|
+
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
305
|
+
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
306
|
+
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
307
|
+
*/
|
|
308
|
+
const clampStringField = (field) => {
|
|
309
|
+
const max = field.maxLength;
|
|
310
|
+
if (max === null) return field;
|
|
311
|
+
const clamped = z.string().overwrite((value) => value.slice(0, max)).max(max);
|
|
312
|
+
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
313
|
+
return field.description ? withMin.describe(field.description) : withMin;
|
|
314
|
+
};
|
|
103
315
|
const toolDefinitionSchema = z.object({
|
|
104
316
|
name: z.string(),
|
|
105
317
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -117,6 +329,10 @@ const positiveTestCaseSchema = z.object({
|
|
|
117
329
|
toolTriggered: z.string().optional(),
|
|
118
330
|
expectedOutput: z.string().optional()
|
|
119
331
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
332
|
+
const screenshotEntrySchema = z.object({
|
|
333
|
+
prompt: z.string(),
|
|
334
|
+
url: z.url().or(z.literal(""))
|
|
335
|
+
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
120
336
|
/** Accepts either a valid email or URL. */
|
|
121
337
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
122
338
|
const chatgptCategorySchema = z.enum([
|
|
@@ -136,6 +352,71 @@ const chatgptCategorySchema = z.enum([
|
|
|
136
352
|
]);
|
|
137
353
|
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
138
354
|
const chatgptAllowedCountriesSchema = z.enum(["Allow all", "Restrict to specific countries"]);
|
|
355
|
+
const chatgptTranslationLocaleSchema = z.enum([
|
|
356
|
+
"am",
|
|
357
|
+
"ar",
|
|
358
|
+
"bg-BG",
|
|
359
|
+
"bn-BD",
|
|
360
|
+
"bs-BA",
|
|
361
|
+
"ca-ES",
|
|
362
|
+
"cs-CZ",
|
|
363
|
+
"da-DK",
|
|
364
|
+
"de-DE",
|
|
365
|
+
"el-GR",
|
|
366
|
+
"es-419",
|
|
367
|
+
"es-ES",
|
|
368
|
+
"et-EE",
|
|
369
|
+
"fi-FI",
|
|
370
|
+
"fr-CA",
|
|
371
|
+
"fr-FR",
|
|
372
|
+
"gu-IN",
|
|
373
|
+
"hi-IN",
|
|
374
|
+
"hr-HR",
|
|
375
|
+
"hu-HU",
|
|
376
|
+
"hy-AM",
|
|
377
|
+
"id-ID",
|
|
378
|
+
"is-IS",
|
|
379
|
+
"it-IT",
|
|
380
|
+
"ja-JP",
|
|
381
|
+
"ka-GE",
|
|
382
|
+
"kk",
|
|
383
|
+
"kn-IN",
|
|
384
|
+
"ko-KR",
|
|
385
|
+
"lt",
|
|
386
|
+
"lv-LV",
|
|
387
|
+
"mk-MK",
|
|
388
|
+
"ml",
|
|
389
|
+
"mn",
|
|
390
|
+
"mr-IN",
|
|
391
|
+
"ms-MY",
|
|
392
|
+
"my-MM",
|
|
393
|
+
"nb-NO",
|
|
394
|
+
"nl-NL",
|
|
395
|
+
"pa",
|
|
396
|
+
"pl-PL",
|
|
397
|
+
"pt-BR",
|
|
398
|
+
"pt-PT",
|
|
399
|
+
"ro-RO",
|
|
400
|
+
"ru-RU",
|
|
401
|
+
"sk-SK",
|
|
402
|
+
"sl-SI",
|
|
403
|
+
"so-SO",
|
|
404
|
+
"sq-AL",
|
|
405
|
+
"sr-RS",
|
|
406
|
+
"sv-SE",
|
|
407
|
+
"sw-TZ",
|
|
408
|
+
"ta-IN",
|
|
409
|
+
"te-IN",
|
|
410
|
+
"th-TH",
|
|
411
|
+
"tl",
|
|
412
|
+
"tr-TR",
|
|
413
|
+
"uk-UA",
|
|
414
|
+
"ur",
|
|
415
|
+
"vi-VN",
|
|
416
|
+
"zh-CN",
|
|
417
|
+
"zh-HK",
|
|
418
|
+
"zh-TW"
|
|
419
|
+
]);
|
|
139
420
|
const negativeTestCaseSchema = z.object({
|
|
140
421
|
scenario: z.string(),
|
|
141
422
|
userPrompt: z.string()
|
|
@@ -146,21 +427,29 @@ const chatgptToolJustificationSchema = z.object({
|
|
|
146
427
|
openWorldJustification: z.string(),
|
|
147
428
|
destructiveJustification: z.string()
|
|
148
429
|
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
430
|
+
/**
|
|
431
|
+
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
432
|
+
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
433
|
+
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
434
|
+
*/
|
|
435
|
+
const chatgptTaglineSchema = z.string().max(30);
|
|
436
|
+
const chatgptDescriptionSchema = z.string();
|
|
149
437
|
const chatgptTranslationSchema = z.object({
|
|
150
|
-
locale:
|
|
151
|
-
tagline:
|
|
152
|
-
description:
|
|
438
|
+
locale: chatgptTranslationLocaleSchema,
|
|
439
|
+
tagline: chatgptTaglineSchema,
|
|
440
|
+
description: chatgptDescriptionSchema
|
|
153
441
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
442
|
+
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
154
443
|
/**
|
|
155
444
|
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
156
445
|
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
157
446
|
*/
|
|
158
447
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
159
448
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
160
|
-
logoDark: z.string().describe("
|
|
449
|
+
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."),
|
|
161
450
|
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
162
|
-
tagline:
|
|
163
|
-
description:
|
|
451
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value. 30 chars max."),
|
|
452
|
+
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
|
|
164
453
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
165
454
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
166
455
|
companyUrl: z.url().describe("Your company's main website URL."),
|
|
@@ -175,7 +464,7 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
175
464
|
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
176
465
|
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Coverage over all major use cases."),
|
|
177
466
|
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases — prompts where the app should NOT trigger but the model might think it's relevant."),
|
|
178
|
-
screenshots: z.array(
|
|
467
|
+
screenshots: z.array(screenshotEntrySchema).describe("In-app screenshots paired with the user prompt that produced them. Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 4 entries. First three are public. Images: 706px wide, 400–860px tall, PNG."),
|
|
179
468
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
180
469
|
allowedCountries: chatgptAllowedCountriesSchema.describe("'Allow all' or restrict to a specific list. See OpenAI's supported countries list."),
|
|
181
470
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
@@ -194,7 +483,7 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
194
483
|
testCases: true,
|
|
195
484
|
negativeTestCases: true,
|
|
196
485
|
toolJustifications: true
|
|
197
|
-
});
|
|
486
|
+
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
198
487
|
const claudeCategorySchema = z.enum([
|
|
199
488
|
"Business & Productivity",
|
|
200
489
|
"Communication",
|
|
@@ -206,7 +495,7 @@ const claudeCategorySchema = z.enum([
|
|
|
206
495
|
"Media & Entertainment",
|
|
207
496
|
"Commerce & Shopping"
|
|
208
497
|
]);
|
|
209
|
-
z.enum([
|
|
498
|
+
const claudeAuthenticationSchema = z.enum([
|
|
210
499
|
"No auth needed",
|
|
211
500
|
"OAuth 2.0",
|
|
212
501
|
"Custom URL"
|
|
@@ -214,28 +503,34 @@ z.enum([
|
|
|
214
503
|
const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
|
|
215
504
|
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
216
505
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
217
|
-
"Read
|
|
218
|
-
"Write
|
|
219
|
-
"Read +
|
|
506
|
+
"Read Only",
|
|
507
|
+
"Write Only",
|
|
508
|
+
"Read + Write"
|
|
220
509
|
]);
|
|
221
510
|
const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
|
|
511
|
+
const claudeTestedSurfaceSchema = z.enum([
|
|
512
|
+
"Claude.ai (web)",
|
|
513
|
+
"Claude Desktop",
|
|
514
|
+
"Claude Code",
|
|
515
|
+
"Cowork"
|
|
516
|
+
]);
|
|
222
517
|
const claudeThirdPartySchema = z.enum([
|
|
223
|
-
"Web access
|
|
224
|
-
"Third-party AI model integration",
|
|
225
|
-
"Third-party data retrieval (
|
|
226
|
-
"Third-party data modification (
|
|
518
|
+
"Web access: Fetches information from the open web (e.g., web scraping, search engines, or browsing arbitrary URLs, not just connecting to a specific API)",
|
|
519
|
+
"Third-party AI model integration: Sends data to or receives data from a generative AI model other than Claude",
|
|
520
|
+
"Third-party data retrieval: Connects to external services that themselves retrieve data from other sources (e.g., workflow automation platforms or other services that aggregate or relay data from multiple third-party sources)",
|
|
521
|
+
"Third-party data modification: Can connect to external services that themselves create, update, or delete data in other sources (e.g., workflow automation platforms or other services that write to multiple third-party sources)",
|
|
227
522
|
"N/A"
|
|
228
523
|
]);
|
|
229
524
|
const claudeDataHandlingSchema = z.enum([
|
|
230
525
|
"Server only accesses data explicitly requested by user",
|
|
231
526
|
"No data is stored beyond session requirements",
|
|
232
|
-
"Data transmission is encrypted (HTTPS
|
|
527
|
+
"Data transmission is encrypted (HTTPS/TLS)",
|
|
233
528
|
"GDPR compliant (if applicable)"
|
|
234
529
|
]);
|
|
235
530
|
const claudeSponsoredContentSchema = z.enum([
|
|
236
531
|
"No, there is no sponsored content or advertisements",
|
|
237
532
|
"Yes, there are banner ads or other paid visual elements",
|
|
238
|
-
"Yes, returned content or ranking is impacted by sponsorship or ad placement"
|
|
533
|
+
"Yes, the returned content or ranking of returned content is impacted by sponsorship or ad placement"
|
|
239
534
|
]);
|
|
240
535
|
/**
|
|
241
536
|
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
@@ -300,7 +595,7 @@ If 'Yes', you will also be required to provide screenshots of your UI (see Promo
|
|
|
300
595
|
Note: These are attestations — you are legally agreeing to these practices by submitting the form.`),
|
|
301
596
|
personalDataHealthAccess: z.boolean().describe(`Select 'Yes' ONLY if your connector gives users access to their own personal health information — such as medical records, lab results, diagnoses, prescriptions, wearable health metrics (heart rate, sleep data, etc.), or mental health data.
|
|
302
597
|
Select 'No' for the vast majority of business/productivity/dev tools. When in doubt, select 'No'. This field triggers additional compliance review if 'Yes'.`),
|
|
303
|
-
|
|
598
|
+
category: claudeCategorySchema.describe(`Select the category that best describes your connector. This determines where it appears in the directory's browse experience. Choose the most specific fit:
|
|
304
599
|
• Business & Productivity — project management, CRM, HR, office tools
|
|
305
600
|
• Communication — email, chat, messaging, notifications
|
|
306
601
|
• Data & Analytics — dashboards, reporting, databases, BI tools
|
|
@@ -310,12 +605,13 @@ Select 'No' for the vast majority of business/productivity/dev tools. When in do
|
|
|
310
605
|
• Health & Life Sciences — clinical, pharma, medical professional tools
|
|
311
606
|
• Media & Entertainment — content, publishing, streaming
|
|
312
607
|
• Commerce & Shopping — e-commerce, inventory, orders
|
|
313
|
-
|
|
608
|
+
Anthropic's submission form only accepts a single category.`),
|
|
314
609
|
sponsoredContentsOrAdvertisement: claudeSponsoredContentSchema.describe(`Be honest here — advertising is not permitted in the Connectors Directory per Anthropic's policy. Select the option that accurately describes your server:
|
|
315
610
|
• 'No, there is no sponsored content or advertisements' — the results your server returns are not influenced by paid placement or sponsorship. This is what almost all connectors should select.
|
|
316
611
|
• 'Yes, there are banner ads or other paid visual elements' — your UI includes visual ads. NOTE: this will likely lead to rejection, as Anthropic prohibits advertising in Claude.
|
|
317
612
|
• 'Yes, the returned content or ranking of returned content is impacted by sponsorship or ad placement' — paid results affect what you return. NOTE: this also likely leads to rejection.
|
|
318
613
|
If your server returns organic results from a platform that has ads in its own UI (but your API results are not affected by ads), select 'No'.`),
|
|
614
|
+
authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
|
|
319
615
|
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
320
616
|
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
321
617
|
• 'SSE (Server-Sent Events)' — the older transport. SSE may be deprecated by Anthropic later in 2025/2026. If you currently only support SSE, you should plan to migrate to Streamable HTTP.
|
|
@@ -355,19 +651,21 @@ Reviewers test every single tool you list here — don't list tools that don't w
|
|
|
355
651
|
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
356
652
|
• 'I've specified accurate tool annotations for all tools' — every tool has the correct annotation: readOnlyHint: true for read operations (search, get, list, fetch), OR destructiveHint: true for write operations (create, update, delete, send).
|
|
357
653
|
This is the #1 reason submissions get rejected (30% of all rejections). Do not check these boxes without actually having implemented the annotations. See MCP spec for how to add them.`),
|
|
358
|
-
|
|
654
|
+
testedSurfaces: z.array(claudeTestedSurfaceSchema).describe(`Confirm testing is complete and your server works as intended in these surfaces. Select every surface you've verified. Claude.ai (web) and Claude Desktop are the usual targets for remote MCP servers; Claude Code and Cowork compatibility is not required. Anthropic requires at least two surfaces.`),
|
|
655
|
+
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
359
656
|
• Format: SVG only
|
|
360
657
|
• Aspect ratio: square (1:1)
|
|
361
|
-
• Should work on
|
|
658
|
+
• Should work on a light background
|
|
362
659
|
• Provide via URL (Google Drive link is fine) or upload directly
|
|
363
660
|
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
364
|
-
|
|
661
|
+
logoDark: z.string().optional().describe(`Optional dark-mode variant of the connector logo. Same specs as the light variant (SVG, square 1:1) but designed to read on a dark background. Leave empty if the light logo already works on dark.`),
|
|
662
|
+
screenshots: z.array(screenshotEntrySchema).describe(`Screenshots or promotional images of your connector in action within Claude. Strongly recommended for all connectors, and required for MCP Apps (interactive UI). Guidelines:
|
|
365
663
|
• 3–5 images is ideal
|
|
366
664
|
• Minimum 1000px width, PNG format preferred
|
|
665
|
+
• Each screenshot is paired with the user prompt that produced it
|
|
367
666
|
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
368
667
|
• Show your connector doing something impressive and useful — real data, real results
|
|
369
668
|
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
370
|
-
• Videos are also welcome
|
|
371
669
|
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
372
670
|
});
|
|
373
671
|
claudeSubmissionFormDataSchema.pick({
|
|
@@ -380,14 +678,20 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
380
678
|
isMcpApp: true,
|
|
381
679
|
transportSupport: true,
|
|
382
680
|
primaryContactEmail: true,
|
|
383
|
-
primaryContactName: true
|
|
681
|
+
primaryContactName: true,
|
|
682
|
+
authentication: true,
|
|
683
|
+
personalDataHealthAccess: true,
|
|
684
|
+
testedSurfaces: true
|
|
685
|
+
}).extend({
|
|
686
|
+
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
687
|
+
testingCredentials: claudeSubmissionFormDataSchema.shape.testingCredentials.optional()
|
|
384
688
|
});
|
|
385
689
|
claudeSubmissionFormDataSchema.pick({
|
|
386
690
|
tagline: true,
|
|
387
691
|
description: true,
|
|
388
|
-
|
|
692
|
+
category: true,
|
|
389
693
|
testCases: true
|
|
390
|
-
});
|
|
694
|
+
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
391
695
|
const submissionMetaFieldsSchema = z.object({
|
|
392
696
|
id: z.string(),
|
|
393
697
|
environmentId: z.string(),
|
|
@@ -410,6 +714,22 @@ const subscriptionPlanSchema = z.enum([
|
|
|
410
714
|
"enterprise"
|
|
411
715
|
]);
|
|
412
716
|
z.object({ plan: subscriptionPlanSchema.nullable() });
|
|
717
|
+
const customerCreditsSchema = z.object({
|
|
718
|
+
balanceInCents: z.number(),
|
|
719
|
+
expiresAt: z.number().nullable(),
|
|
720
|
+
currency: z.string()
|
|
721
|
+
});
|
|
722
|
+
const customerUsageSchema = z.object({
|
|
723
|
+
amountInCents: z.number(),
|
|
724
|
+
currency: z.string(),
|
|
725
|
+
periodEnd: z.number()
|
|
726
|
+
});
|
|
727
|
+
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
728
|
+
z.object({
|
|
729
|
+
customerCredits: customerCreditsSchema.nullable(),
|
|
730
|
+
customerUsage: customerUsageSchema.nullable(),
|
|
731
|
+
partnerDiscount: partnerDiscountSchema.nullable()
|
|
732
|
+
});
|
|
413
733
|
//#endregion
|
|
414
734
|
//#region src/schemas.ts
|
|
415
735
|
const RESERVED_KEYS = [
|
|
@@ -464,17 +784,6 @@ const buildSettingsSchema = z.object({
|
|
|
464
784
|
buildOutputDir: z.string().optional(),
|
|
465
785
|
startCommand: z.string().optional()
|
|
466
786
|
});
|
|
467
|
-
const runtimeSchema = z.enum([
|
|
468
|
-
"python3.13",
|
|
469
|
-
"python3.14",
|
|
470
|
-
"node22",
|
|
471
|
-
"node24"
|
|
472
|
-
]);
|
|
473
|
-
const transportSchema = z.enum([
|
|
474
|
-
"stdio",
|
|
475
|
-
"sse",
|
|
476
|
-
"streamablehttp"
|
|
477
|
-
]);
|
|
478
787
|
const playgroundHeaderSchema = z.object({
|
|
479
788
|
name: z.string().min(1).max(100),
|
|
480
789
|
description: z.string().max(200),
|
|
@@ -577,7 +886,7 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
577
886
|
name: z.string(),
|
|
578
887
|
sourceBranch: z.string().nullable(),
|
|
579
888
|
mcpServerUrl: z.string(),
|
|
580
|
-
domains: z.array(z.
|
|
889
|
+
domains: z.array(z.hostname()),
|
|
581
890
|
createdAt: z.coerce.date(),
|
|
582
891
|
projectId: z.string()
|
|
583
892
|
}));
|
|
@@ -1037,7 +1346,8 @@ const createBeaconContractV1 = oc.route({
|
|
|
1037
1346
|
successDescription: "The audit has been created"
|
|
1038
1347
|
}).errors({
|
|
1039
1348
|
NOT_FOUND: {},
|
|
1040
|
-
BAD_REQUEST: {}
|
|
1349
|
+
BAD_REQUEST: {},
|
|
1350
|
+
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1041
1351
|
}).input(z.object({
|
|
1042
1352
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
1043
1353
|
teamId: z.string().optional().describe("The team ID to associate the audit with"),
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@alpic-ai/api",
|
|
3
|
-
"version": "0.0.0-dev.
|
|
3
|
+
"version": "0.0.0-dev.ge3cead0",
|
|
4
4
|
"description": "Contract for the Alpic API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.mjs",
|
|
@@ -14,15 +14,6 @@
|
|
|
14
14
|
"files": [
|
|
15
15
|
"dist"
|
|
16
16
|
],
|
|
17
|
-
"nx": {
|
|
18
|
-
"targets": {
|
|
19
|
-
"build": {
|
|
20
|
-
"dependsOn": [
|
|
21
|
-
"^build"
|
|
22
|
-
]
|
|
23
|
-
}
|
|
24
|
-
}
|
|
25
|
-
},
|
|
26
17
|
"author": "Alpic",
|
|
27
18
|
"license": "ISC",
|
|
28
19
|
"dependencies": {
|