@alpic-ai/api 0.0.0-dev.ge5495cb → 0.0.0-dev.ge55284d
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 +4779 -53
- package/dist/index.mjs +279 -29
- package/package.json +8 -8
package/dist/index.mjs
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
import * as z$1 from "zod/v4";
|
|
3
3
|
import { oc } from "@orpc/contract";
|
|
4
4
|
import ms from "ms";
|
|
5
|
-
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.0_supports-color@7.2.0_zod@4.4
|
|
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
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -179,6 +179,7 @@ const PLATFORM_LABELS = {
|
|
|
179
179
|
};
|
|
180
180
|
const WAF_PLATFORMS = [
|
|
181
181
|
"akamai",
|
|
182
|
+
"cato",
|
|
182
183
|
"cloudflare",
|
|
183
184
|
"fastly"
|
|
184
185
|
];
|
|
@@ -261,11 +262,10 @@ const creditEntryReasonSchema = z.enum([
|
|
|
261
262
|
"paid_conversion_floor",
|
|
262
263
|
"top_up",
|
|
263
264
|
"usage",
|
|
264
|
-
"refund",
|
|
265
265
|
"admin_adjustment"
|
|
266
266
|
]);
|
|
267
267
|
z.enum(["playground"]);
|
|
268
|
-
z.number().int().min(500)
|
|
268
|
+
z.number().int().min(500);
|
|
269
269
|
const creditActivityEntrySchema = z.object({
|
|
270
270
|
reason: creditEntryReasonSchema,
|
|
271
271
|
day: z.number(),
|
|
@@ -274,7 +274,6 @@ const creditActivityEntrySchema = z.object({
|
|
|
274
274
|
});
|
|
275
275
|
z.object({
|
|
276
276
|
balanceInNanoUSD: z.number(),
|
|
277
|
-
canTopUp: z.boolean(),
|
|
278
277
|
recentActivity: z.array(creditActivityEntrySchema)
|
|
279
278
|
});
|
|
280
279
|
const deploymentStatusSchema$1 = z.enum([
|
|
@@ -421,7 +420,8 @@ z.object({
|
|
|
421
420
|
collectResponsePayload: z.boolean(),
|
|
422
421
|
collectErrorMessage: z.boolean(),
|
|
423
422
|
collectUserData: z.boolean(),
|
|
424
|
-
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
423
|
+
identityTraitKey: z.string().min(1).max(200).nullable(),
|
|
424
|
+
leadEventName: z.string().min(1).max(200).nullable()
|
|
425
425
|
});
|
|
426
426
|
const feedbackSchema = z.object({
|
|
427
427
|
id: z.string(),
|
|
@@ -524,6 +524,16 @@ z.object({
|
|
|
524
524
|
createdAt: z.coerce.date(),
|
|
525
525
|
updatedAt: z.coerce.date()
|
|
526
526
|
});
|
|
527
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
528
|
+
type: z.literal("mcp_request"),
|
|
529
|
+
method: z.string()
|
|
530
|
+
});
|
|
531
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
532
|
+
type: z.literal("mcp_error"),
|
|
533
|
+
method: z.string(),
|
|
534
|
+
error: z.string()
|
|
535
|
+
});
|
|
536
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
527
537
|
z.enum([
|
|
528
538
|
"INFO",
|
|
529
539
|
"WARNING",
|
|
@@ -855,6 +865,10 @@ const clampStringField = (field) => {
|
|
|
855
865
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
856
866
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
857
867
|
};
|
|
868
|
+
const unboundedArrayField = (field) => {
|
|
869
|
+
const unbounded = z.array(field.element);
|
|
870
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
871
|
+
};
|
|
858
872
|
const toolDefinitionSchema = z.object({
|
|
859
873
|
name: z.string(),
|
|
860
874
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -867,11 +881,22 @@ const toolDefinitionSchema = z.object({
|
|
|
867
881
|
}).optional()
|
|
868
882
|
});
|
|
869
883
|
const positiveTestCaseSchema = z.object({
|
|
870
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
871
|
-
userPrompt: z.string().describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
884
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
885
|
+
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."),
|
|
872
886
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
873
887
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
874
|
-
}).
|
|
888
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
889
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
890
|
+
scenario: z.string().optional(),
|
|
891
|
+
userPrompt: z.string().optional()
|
|
892
|
+
});
|
|
893
|
+
const blankPositiveTestCase = () => ({
|
|
894
|
+
scenario: "",
|
|
895
|
+
userPrompt: "",
|
|
896
|
+
toolTriggered: "",
|
|
897
|
+
expectedOutput: ""
|
|
898
|
+
});
|
|
899
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
875
900
|
const screenshotEntrySchema = z.object({
|
|
876
901
|
prompt: z.string(),
|
|
877
902
|
url: z.url()
|
|
@@ -1184,9 +1209,18 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
1184
1209
|
"zh-TW"
|
|
1185
1210
|
]);
|
|
1186
1211
|
const negativeTestCaseSchema = z.object({
|
|
1187
|
-
scenario: z.string(),
|
|
1188
|
-
userPrompt: z.string()
|
|
1189
|
-
}).
|
|
1212
|
+
scenario: z.string().min(1),
|
|
1213
|
+
userPrompt: z.string().min(1)
|
|
1214
|
+
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1215
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1216
|
+
scenario: z.string().optional(),
|
|
1217
|
+
userPrompt: z.string().optional()
|
|
1218
|
+
});
|
|
1219
|
+
const blankNegativeTestCase = () => ({
|
|
1220
|
+
scenario: "",
|
|
1221
|
+
userPrompt: ""
|
|
1222
|
+
});
|
|
1223
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
1190
1224
|
const chatgptToolJustificationSchema = z.object({
|
|
1191
1225
|
toolName: z.string(),
|
|
1192
1226
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
@@ -1221,8 +1255,9 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
1221
1255
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
1222
1256
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1223
1257
|
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."),
|
|
1224
|
-
|
|
1225
|
-
|
|
1258
|
+
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."),
|
|
1259
|
+
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."),
|
|
1260
|
+
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."),
|
|
1226
1261
|
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."),
|
|
1227
1262
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1228
1263
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
@@ -1237,23 +1272,35 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
1237
1272
|
demoRecordingUrl: z.string().optional(),
|
|
1238
1273
|
serverUrl: z.string().optional(),
|
|
1239
1274
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1275
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1276
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1240
1277
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1241
1278
|
});
|
|
1242
|
-
|
|
1279
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1280
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1243
1281
|
appName: true,
|
|
1244
1282
|
developerName: true,
|
|
1245
1283
|
serverUrl: true,
|
|
1246
1284
|
tools: true,
|
|
1285
|
+
skills: true,
|
|
1247
1286
|
authentication: true
|
|
1248
1287
|
});
|
|
1249
|
-
|
|
1288
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1289
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1250
1290
|
tagline: true,
|
|
1251
1291
|
description: true,
|
|
1252
1292
|
category: true,
|
|
1253
1293
|
testCases: true,
|
|
1254
1294
|
negativeTestCases: true,
|
|
1255
1295
|
toolJustifications: true
|
|
1256
|
-
}).extend({
|
|
1296
|
+
}).extend({
|
|
1297
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1298
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1299
|
+
}).extend({
|
|
1300
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1301
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1302
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1303
|
+
});
|
|
1257
1304
|
const claudeCategorySchema = z.enum([
|
|
1258
1305
|
"Productivity",
|
|
1259
1306
|
"Communication",
|
|
@@ -1376,7 +1423,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1376
1423
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1377
1424
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1378
1425
|
});
|
|
1379
|
-
|
|
1426
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1427
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1380
1428
|
serverUrl: true,
|
|
1381
1429
|
name: true,
|
|
1382
1430
|
slug: true,
|
|
@@ -1398,27 +1446,81 @@ const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
|
1398
1446
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1399
1447
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1400
1448
|
});
|
|
1401
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1449
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1402
1450
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1403
1451
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1404
1452
|
});
|
|
1453
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1454
|
+
const byField = {};
|
|
1455
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1456
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1457
|
+
return byField;
|
|
1458
|
+
}
|
|
1459
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1460
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1461
|
+
"pass",
|
|
1462
|
+
"fail",
|
|
1463
|
+
"unverified"
|
|
1464
|
+
]);
|
|
1465
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1466
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1467
|
+
claudeai: ["privacyPolicy"]
|
|
1468
|
+
};
|
|
1469
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1470
|
+
const policyDisclosureSchema = z.enum([
|
|
1471
|
+
"dataCategories",
|
|
1472
|
+
"purposesOfUse",
|
|
1473
|
+
"recipients",
|
|
1474
|
+
"retention"
|
|
1475
|
+
]);
|
|
1476
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1477
|
+
field: verifiableUrlFieldSchema,
|
|
1478
|
+
url: z.string(),
|
|
1479
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1480
|
+
reason: z.string(),
|
|
1481
|
+
concerns: z.array(z.string()).optional(),
|
|
1482
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1483
|
+
});
|
|
1484
|
+
const urlVerificationSchema = z.object({
|
|
1485
|
+
verifiedAt: z.coerce.date(),
|
|
1486
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1487
|
+
});
|
|
1488
|
+
const pageKindSchema = z.enum([
|
|
1489
|
+
"expectedDocument",
|
|
1490
|
+
"errorPage",
|
|
1491
|
+
"loginWall",
|
|
1492
|
+
"parkedDomain",
|
|
1493
|
+
"comingSoon",
|
|
1494
|
+
"marketingPage",
|
|
1495
|
+
"unrelatedDocument"
|
|
1496
|
+
]);
|
|
1497
|
+
z.object({
|
|
1498
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1499
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1500
|
+
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.")
|
|
1501
|
+
});
|
|
1405
1502
|
const submissionMetaFieldsSchema = z.object({
|
|
1406
1503
|
id: z.string(),
|
|
1407
1504
|
environmentId: z.string(),
|
|
1408
1505
|
auditId: z.string().nullable(),
|
|
1506
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1409
1507
|
createdAt: z.coerce.date(),
|
|
1410
1508
|
updatedAt: z.coerce.date()
|
|
1411
1509
|
});
|
|
1412
1510
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1413
1511
|
platform: z.literal("claudeai"),
|
|
1414
|
-
formData: claudeSubmissionDraftSchema
|
|
1512
|
+
formData: claudeSubmissionDraftSchema,
|
|
1513
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1415
1514
|
});
|
|
1416
1515
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1417
1516
|
platform: z.literal("chatgpt"),
|
|
1418
|
-
formData: chatgptSubmissionDraftSchema
|
|
1517
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1518
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1419
1519
|
});
|
|
1420
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1520
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1421
1521
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1522
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1523
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1422
1524
|
z.literal([
|
|
1423
1525
|
100,
|
|
1424
1526
|
75,
|
|
@@ -1435,17 +1537,70 @@ const customerCreditsSchema = z.object({
|
|
|
1435
1537
|
expiresAt: z.number().nullable(),
|
|
1436
1538
|
currency: z.string()
|
|
1437
1539
|
});
|
|
1438
|
-
const customerUsageSchema = z.object({
|
|
1439
|
-
amountInCents: z.number(),
|
|
1440
|
-
currency: z.string(),
|
|
1441
|
-
periodEnd: z.number()
|
|
1442
|
-
});
|
|
1443
1540
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1444
1541
|
z.object({
|
|
1445
1542
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1446
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1447
1543
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1448
1544
|
});
|
|
1545
|
+
const metricsQueueEventSchema = z.object({
|
|
1546
|
+
ts: z.number().int(),
|
|
1547
|
+
method: z.string(),
|
|
1548
|
+
tool: z.string().nullable(),
|
|
1549
|
+
client: z.string(),
|
|
1550
|
+
sessionId: z.string().nullable(),
|
|
1551
|
+
durationMs: z.number().int(),
|
|
1552
|
+
outputTokens: z.number().int().nullable(),
|
|
1553
|
+
errorType: z.enum([
|
|
1554
|
+
"mcp_error",
|
|
1555
|
+
"tool_error",
|
|
1556
|
+
"timeout"
|
|
1557
|
+
]).nullable(),
|
|
1558
|
+
errorCode: z.number().int().nullable()
|
|
1559
|
+
});
|
|
1560
|
+
z.object({
|
|
1561
|
+
v: z.literal(1),
|
|
1562
|
+
envId: z.string(),
|
|
1563
|
+
events: z.array(metricsQueueEventSchema)
|
|
1564
|
+
});
|
|
1565
|
+
z.object({ v: z.number() });
|
|
1566
|
+
const telemetrySignalSchema = z.enum([
|
|
1567
|
+
"logs",
|
|
1568
|
+
"metrics",
|
|
1569
|
+
"traces"
|
|
1570
|
+
]);
|
|
1571
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1572
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1573
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1574
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1575
|
+
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");
|
|
1576
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1577
|
+
id: z.string(),
|
|
1578
|
+
name: otlpHeaderNameSchema,
|
|
1579
|
+
value: otlpHeaderValueSchema,
|
|
1580
|
+
isSecret: z.boolean()
|
|
1581
|
+
});
|
|
1582
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1583
|
+
"credentials",
|
|
1584
|
+
"wrong-path",
|
|
1585
|
+
"wrong-protocol",
|
|
1586
|
+
"invalid-payload",
|
|
1587
|
+
"partial-rejection",
|
|
1588
|
+
"blocked-target",
|
|
1589
|
+
"timeout",
|
|
1590
|
+
"unreachable",
|
|
1591
|
+
"receiver-error",
|
|
1592
|
+
"unexpected-status"
|
|
1593
|
+
]);
|
|
1594
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1595
|
+
z.object({
|
|
1596
|
+
id: z.string(),
|
|
1597
|
+
signal: telemetrySignalSchema,
|
|
1598
|
+
endpoint: otlpEndpointSchema,
|
|
1599
|
+
protocol: otlpProtocolSchema,
|
|
1600
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1601
|
+
status: telemetryDestinationStatusSchema,
|
|
1602
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1603
|
+
});
|
|
1449
1604
|
//#endregion
|
|
1450
1605
|
//#region src/auth-scope.ts
|
|
1451
1606
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1544,6 +1699,14 @@ const serverFieldsSchema = z.object({
|
|
|
1544
1699
|
});
|
|
1545
1700
|
//#endregion
|
|
1546
1701
|
//#region src/api.contract.ts
|
|
1702
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1703
|
+
try {
|
|
1704
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1705
|
+
return true;
|
|
1706
|
+
} catch {
|
|
1707
|
+
return false;
|
|
1708
|
+
}
|
|
1709
|
+
};
|
|
1547
1710
|
const deploymentStatusSchema = z.enum([
|
|
1548
1711
|
"ongoing",
|
|
1549
1712
|
"deployed",
|
|
@@ -1614,6 +1777,14 @@ const getEnvironmentContractV1 = base.route({
|
|
|
1614
1777
|
createdAt: z.coerce.date(),
|
|
1615
1778
|
projectId: z.string()
|
|
1616
1779
|
}));
|
|
1780
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1781
|
+
path: "/v1/environments/{environmentId}",
|
|
1782
|
+
method: "DELETE",
|
|
1783
|
+
summary: "Delete an environment",
|
|
1784
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1785
|
+
tags: ["environments"],
|
|
1786
|
+
successDescription: "The environment has been deleted successfully"
|
|
1787
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1617
1788
|
const domainSchema = z.object({
|
|
1618
1789
|
domain: z.string(),
|
|
1619
1790
|
status: z.enum([
|
|
@@ -1926,7 +2097,7 @@ const getProjectAnalyticsContractV1 = base.route({
|
|
|
1926
2097
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1927
2098
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1928
2099
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1929
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2100
|
+
}).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({
|
|
1930
2101
|
metadata: z.object({
|
|
1931
2102
|
startTimestamp: z.number(),
|
|
1932
2103
|
endTimestamp: z.number(),
|
|
@@ -2196,6 +2367,57 @@ const getBeaconContractV1 = base.route({
|
|
|
2196
2367
|
createdAt: z.coerce.date(),
|
|
2197
2368
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
2198
2369
|
}));
|
|
2370
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2371
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2372
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2373
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2374
|
+
const createSubmissionContractV1 = base.route({
|
|
2375
|
+
path: "/v1/submissions",
|
|
2376
|
+
method: "POST",
|
|
2377
|
+
summary: "Create a submission package",
|
|
2378
|
+
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.",
|
|
2379
|
+
tags: ["submissions"],
|
|
2380
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2381
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2382
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2383
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2384
|
+
})).output(submissionSchema);
|
|
2385
|
+
const listSubmissionsContractV1 = base.route({
|
|
2386
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2387
|
+
method: "GET",
|
|
2388
|
+
summary: "List submission packages",
|
|
2389
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2390
|
+
tags: ["submissions"],
|
|
2391
|
+
successDescription: "The list of submission packages"
|
|
2392
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2393
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2394
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2395
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2396
|
+
})).output(z.array(submissionSchema));
|
|
2397
|
+
const getSubmissionContractV1 = base.route({
|
|
2398
|
+
path: "/v1/submissions/{submissionId}",
|
|
2399
|
+
method: "GET",
|
|
2400
|
+
summary: "Get a submission package",
|
|
2401
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2402
|
+
tags: ["submissions"],
|
|
2403
|
+
successDescription: "The submission package"
|
|
2404
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2405
|
+
const updateSubmissionContractV1 = base.route({
|
|
2406
|
+
path: "/v1/submissions/{submissionId}",
|
|
2407
|
+
method: "PUT",
|
|
2408
|
+
summary: "Update a submission package",
|
|
2409
|
+
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.",
|
|
2410
|
+
tags: ["submissions"],
|
|
2411
|
+
successDescription: "The updated submission package"
|
|
2412
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2413
|
+
submissionId: submissionIdSchema,
|
|
2414
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2415
|
+
formData: claudeSubmissionUpdateSchema
|
|
2416
|
+
}), z.object({
|
|
2417
|
+
submissionId: submissionIdSchema,
|
|
2418
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2419
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2420
|
+
})])).output(submissionSchema);
|
|
2199
2421
|
const contract = {
|
|
2200
2422
|
teams: {
|
|
2201
2423
|
list: { v1: listTeamsContractV1 },
|
|
@@ -2221,6 +2443,7 @@ const contract = {
|
|
|
2221
2443
|
environments: {
|
|
2222
2444
|
create: { v1: createEnvironmentContractV1 },
|
|
2223
2445
|
get: { v1: getEnvironmentContractV1 },
|
|
2446
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
2224
2447
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
2225
2448
|
getLogs: { v1: getLogsContractV1 },
|
|
2226
2449
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -2250,6 +2473,12 @@ const contract = {
|
|
|
2250
2473
|
beacon: {
|
|
2251
2474
|
create: { v1: createBeaconContractV1 },
|
|
2252
2475
|
get: { v1: getBeaconContractV1 }
|
|
2476
|
+
},
|
|
2477
|
+
submissions: {
|
|
2478
|
+
create: { v1: createSubmissionContractV1 },
|
|
2479
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2480
|
+
get: { v1: getSubmissionContractV1 },
|
|
2481
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2253
2482
|
}
|
|
2254
2483
|
};
|
|
2255
2484
|
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
@@ -2257,5 +2486,26 @@ const contractForDocs = {
|
|
|
2257
2486
|
...contract,
|
|
2258
2487
|
deployments: deploymentsForDocs
|
|
2259
2488
|
};
|
|
2489
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2490
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2491
|
+
info: {
|
|
2492
|
+
title: "Alpic API",
|
|
2493
|
+
version: "1.0.0"
|
|
2494
|
+
},
|
|
2495
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2496
|
+
security: [{ bearerAuth: [] }],
|
|
2497
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2498
|
+
type: "http",
|
|
2499
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2500
|
+
scheme: "bearer"
|
|
2501
|
+
} } },
|
|
2502
|
+
commonSchemas: {
|
|
2503
|
+
Submission: { schema: submissionSchema },
|
|
2504
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2505
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2506
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2507
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
2508
|
+
}
|
|
2509
|
+
};
|
|
2260
2510
|
//#endregion
|
|
2261
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2511
|
+
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 };
|
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.ge55284d",
|
|
4
4
|
"description": "Contract for the Alpic API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.mjs",
|
|
@@ -33,20 +33,20 @@
|
|
|
33
33
|
"author": "Alpic",
|
|
34
34
|
"license": "ISC",
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"@orpc/contract": "^1.15.
|
|
36
|
+
"@orpc/contract": "^1.15.2",
|
|
37
37
|
"ms": "^2.1.3",
|
|
38
|
-
"zod": "^4.4
|
|
38
|
+
"zod": "^4.5.4"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
|
-
"@
|
|
42
|
-
"@orpc/
|
|
41
|
+
"@alpic-ai/domains": "0.0.0",
|
|
42
|
+
"@orpc/openapi": "^1.15.2",
|
|
43
|
+
"@orpc/zod": "^1.15.2",
|
|
43
44
|
"@total-typescript/tsconfig": "^1.0.4",
|
|
44
45
|
"@types/ms": "^2.1.0",
|
|
45
46
|
"shx": "^0.4.0",
|
|
46
|
-
"tsdown": "^0.
|
|
47
|
+
"tsdown": "^0.23.0",
|
|
47
48
|
"typescript": "^6.0.3",
|
|
48
|
-
"vitest": "^
|
|
49
|
-
"@alpic-ai/domains": "0.0.0"
|
|
49
|
+
"vitest": "^5.0.1"
|
|
50
50
|
},
|
|
51
51
|
"scripts": {
|
|
52
52
|
"build": "shx rm -rf dist && tsdown",
|