@alpic-ai/api 0.0.0-dev.gef12e79 → 0.0.0-dev.gef36c2a
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 +4753 -55
- package/dist/index.mjs +238 -46
- package/package.json +5 -5
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
|
];
|
|
@@ -256,16 +257,25 @@ z.object({
|
|
|
256
257
|
clientSecret: z.string(),
|
|
257
258
|
clientScopes: z.array(z.string())
|
|
258
259
|
});
|
|
259
|
-
z.enum([
|
|
260
|
-
"opening_balance",
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
261
|
"free_seed",
|
|
262
262
|
"paid_conversion_floor",
|
|
263
263
|
"top_up",
|
|
264
264
|
"usage",
|
|
265
|
-
"refund",
|
|
266
265
|
"admin_adjustment"
|
|
267
266
|
]);
|
|
268
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
|
+
});
|
|
269
279
|
const deploymentStatusSchema$1 = z.enum([
|
|
270
280
|
"ongoing",
|
|
271
281
|
"deployed",
|
|
@@ -854,6 +864,10 @@ const clampStringField = (field) => {
|
|
|
854
864
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
855
865
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
856
866
|
};
|
|
867
|
+
const unboundedArrayField = (field) => {
|
|
868
|
+
const unbounded = z.array(field.element);
|
|
869
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
870
|
+
};
|
|
857
871
|
const toolDefinitionSchema = z.object({
|
|
858
872
|
name: z.string(),
|
|
859
873
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -866,11 +880,22 @@ const toolDefinitionSchema = z.object({
|
|
|
866
880
|
}).optional()
|
|
867
881
|
});
|
|
868
882
|
const positiveTestCaseSchema = z.object({
|
|
869
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
870
|
-
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."),
|
|
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."),
|
|
871
885
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
872
886
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
873
|
-
}).
|
|
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());
|
|
874
899
|
const screenshotEntrySchema = z.object({
|
|
875
900
|
prompt: z.string(),
|
|
876
901
|
url: z.url()
|
|
@@ -1183,9 +1208,18 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
1183
1208
|
"zh-TW"
|
|
1184
1209
|
]);
|
|
1185
1210
|
const negativeTestCaseSchema = z.object({
|
|
1186
|
-
scenario: z.string(),
|
|
1187
|
-
userPrompt: z.string()
|
|
1188
|
-
}).
|
|
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.");
|
|
1189
1223
|
const chatgptToolJustificationSchema = z.object({
|
|
1190
1224
|
toolName: z.string(),
|
|
1191
1225
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
@@ -1220,8 +1254,9 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
1220
1254
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
1221
1255
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1222
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."),
|
|
1223
|
-
|
|
1224
|
-
|
|
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."),
|
|
1225
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."),
|
|
1226
1261
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1227
1262
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
@@ -1236,23 +1271,35 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
1236
1271
|
demoRecordingUrl: z.string().optional(),
|
|
1237
1272
|
serverUrl: z.string().optional(),
|
|
1238
1273
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1274
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1275
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1239
1276
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1240
1277
|
});
|
|
1241
|
-
|
|
1278
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1279
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1242
1280
|
appName: true,
|
|
1243
1281
|
developerName: true,
|
|
1244
1282
|
serverUrl: true,
|
|
1245
1283
|
tools: true,
|
|
1284
|
+
skills: true,
|
|
1246
1285
|
authentication: true
|
|
1247
1286
|
});
|
|
1248
|
-
|
|
1287
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1288
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1249
1289
|
tagline: true,
|
|
1250
1290
|
description: true,
|
|
1251
1291
|
category: true,
|
|
1252
1292
|
testCases: true,
|
|
1253
1293
|
negativeTestCases: true,
|
|
1254
1294
|
toolJustifications: true
|
|
1255
|
-
}).extend({
|
|
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
|
+
});
|
|
1256
1303
|
const claudeCategorySchema = z.enum([
|
|
1257
1304
|
"Productivity",
|
|
1258
1305
|
"Communication",
|
|
@@ -1375,7 +1422,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1375
1422
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1376
1423
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1377
1424
|
});
|
|
1378
|
-
|
|
1425
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1426
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1379
1427
|
serverUrl: true,
|
|
1380
1428
|
name: true,
|
|
1381
1429
|
slug: true,
|
|
@@ -1397,27 +1445,81 @@ const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
|
1397
1445
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1398
1446
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1399
1447
|
});
|
|
1400
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1448
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1401
1449
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1402
1450
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1403
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
|
+
});
|
|
1404
1501
|
const submissionMetaFieldsSchema = z.object({
|
|
1405
1502
|
id: z.string(),
|
|
1406
1503
|
environmentId: z.string(),
|
|
1407
1504
|
auditId: z.string().nullable(),
|
|
1505
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1408
1506
|
createdAt: z.coerce.date(),
|
|
1409
1507
|
updatedAt: z.coerce.date()
|
|
1410
1508
|
});
|
|
1411
1509
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1412
1510
|
platform: z.literal("claudeai"),
|
|
1413
|
-
formData: claudeSubmissionDraftSchema
|
|
1511
|
+
formData: claudeSubmissionDraftSchema,
|
|
1512
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1414
1513
|
});
|
|
1415
1514
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1416
1515
|
platform: z.literal("chatgpt"),
|
|
1417
|
-
formData: chatgptSubmissionDraftSchema
|
|
1516
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1517
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1418
1518
|
});
|
|
1419
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1519
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1420
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;
|
|
1421
1523
|
z.literal([
|
|
1422
1524
|
100,
|
|
1423
1525
|
75,
|
|
@@ -1434,18 +1536,32 @@ const customerCreditsSchema = z.object({
|
|
|
1434
1536
|
expiresAt: z.number().nullable(),
|
|
1435
1537
|
currency: z.string()
|
|
1436
1538
|
});
|
|
1437
|
-
const customerUsageSchema = z.object({
|
|
1438
|
-
amountInCents: z.number(),
|
|
1439
|
-
currency: z.string(),
|
|
1440
|
-
periodEnd: z.number()
|
|
1441
|
-
});
|
|
1442
1539
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1443
|
-
z.object({ balanceInNanoUSD: z.number() });
|
|
1444
1540
|
z.object({
|
|
1445
1541
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1446
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1447
1542
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1448
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() });
|
|
1449
1565
|
const telemetrySignalSchema = z.enum([
|
|
1450
1566
|
"logs",
|
|
1451
1567
|
"metrics",
|
|
@@ -1456,29 +1572,13 @@ const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
|
1456
1572
|
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1457
1573
|
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1458
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");
|
|
1459
|
-
const logSeveritySchema = z.enum([
|
|
1460
|
-
"TRACE",
|
|
1461
|
-
"DEBUG",
|
|
1462
|
-
"INFO",
|
|
1463
|
-
"WARN",
|
|
1464
|
-
"ERROR",
|
|
1465
|
-
"FATAL"
|
|
1466
|
-
]);
|
|
1467
1575
|
const telemetryDestinationHeaderSchema = z.object({
|
|
1468
1576
|
id: z.string(),
|
|
1469
1577
|
name: otlpHeaderNameSchema,
|
|
1470
1578
|
value: otlpHeaderValueSchema,
|
|
1471
1579
|
isSecret: z.boolean()
|
|
1472
1580
|
});
|
|
1473
|
-
z.
|
|
1474
|
-
id: z.string(),
|
|
1475
|
-
signal: telemetrySignalSchema,
|
|
1476
|
-
endpoint: otlpEndpointSchema,
|
|
1477
|
-
protocol: otlpProtocolSchema,
|
|
1478
|
-
minimumSeverity: logSeveritySchema,
|
|
1479
|
-
headers: z.array(telemetryDestinationHeaderSchema)
|
|
1480
|
-
});
|
|
1481
|
-
z.enum([
|
|
1581
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1482
1582
|
"credentials",
|
|
1483
1583
|
"wrong-path",
|
|
1484
1584
|
"wrong-protocol",
|
|
@@ -1490,6 +1590,16 @@ z.enum([
|
|
|
1490
1590
|
"receiver-error",
|
|
1491
1591
|
"unexpected-status"
|
|
1492
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
|
+
});
|
|
1493
1603
|
//#endregion
|
|
1494
1604
|
//#region src/auth-scope.ts
|
|
1495
1605
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1588,6 +1698,14 @@ const serverFieldsSchema = z.object({
|
|
|
1588
1698
|
});
|
|
1589
1699
|
//#endregion
|
|
1590
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
|
+
};
|
|
1591
1709
|
const deploymentStatusSchema = z.enum([
|
|
1592
1710
|
"ongoing",
|
|
1593
1711
|
"deployed",
|
|
@@ -1658,6 +1776,14 @@ const getEnvironmentContractV1 = base.route({
|
|
|
1658
1776
|
createdAt: z.coerce.date(),
|
|
1659
1777
|
projectId: z.string()
|
|
1660
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) }));
|
|
1661
1787
|
const domainSchema = z.object({
|
|
1662
1788
|
domain: z.string(),
|
|
1663
1789
|
status: z.enum([
|
|
@@ -1970,7 +2096,7 @@ const getProjectAnalyticsContractV1 = base.route({
|
|
|
1970
2096
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1971
2097
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1972
2098
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1973
|
-
}).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 }) =>
|
|
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({
|
|
1974
2100
|
metadata: z.object({
|
|
1975
2101
|
startTimestamp: z.number(),
|
|
1976
2102
|
endTimestamp: z.number(),
|
|
@@ -2240,6 +2366,45 @@ const getBeaconContractV1 = base.route({
|
|
|
2240
2366
|
createdAt: z.coerce.date(),
|
|
2241
2367
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
2242
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 getSubmissionContractV1 = base.route({
|
|
2385
|
+
path: "/v1/submissions/{submissionId}",
|
|
2386
|
+
method: "GET",
|
|
2387
|
+
summary: "Get a submission package",
|
|
2388
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2389
|
+
tags: ["submissions"],
|
|
2390
|
+
successDescription: "The submission package"
|
|
2391
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2392
|
+
const updateSubmissionContractV1 = base.route({
|
|
2393
|
+
path: "/v1/submissions/{submissionId}",
|
|
2394
|
+
method: "PUT",
|
|
2395
|
+
summary: "Update a submission package",
|
|
2396
|
+
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.",
|
|
2397
|
+
tags: ["submissions"],
|
|
2398
|
+
successDescription: "The updated submission package"
|
|
2399
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2400
|
+
submissionId: submissionIdSchema,
|
|
2401
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2402
|
+
formData: claudeSubmissionUpdateSchema
|
|
2403
|
+
}), z.object({
|
|
2404
|
+
submissionId: submissionIdSchema,
|
|
2405
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2406
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2407
|
+
})])).output(submissionSchema);
|
|
2243
2408
|
const contract = {
|
|
2244
2409
|
teams: {
|
|
2245
2410
|
list: { v1: listTeamsContractV1 },
|
|
@@ -2265,6 +2430,7 @@ const contract = {
|
|
|
2265
2430
|
environments: {
|
|
2266
2431
|
create: { v1: createEnvironmentContractV1 },
|
|
2267
2432
|
get: { v1: getEnvironmentContractV1 },
|
|
2433
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
2268
2434
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
2269
2435
|
getLogs: { v1: getLogsContractV1 },
|
|
2270
2436
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -2294,6 +2460,11 @@ const contract = {
|
|
|
2294
2460
|
beacon: {
|
|
2295
2461
|
create: { v1: createBeaconContractV1 },
|
|
2296
2462
|
get: { v1: getBeaconContractV1 }
|
|
2463
|
+
},
|
|
2464
|
+
submissions: {
|
|
2465
|
+
create: { v1: createSubmissionContractV1 },
|
|
2466
|
+
get: { v1: getSubmissionContractV1 },
|
|
2467
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2297
2468
|
}
|
|
2298
2469
|
};
|
|
2299
2470
|
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
@@ -2301,5 +2472,26 @@ const contractForDocs = {
|
|
|
2301
2472
|
...contract,
|
|
2302
2473
|
deployments: deploymentsForDocs
|
|
2303
2474
|
};
|
|
2475
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2476
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2477
|
+
info: {
|
|
2478
|
+
title: "Alpic API",
|
|
2479
|
+
version: "1.0.0"
|
|
2480
|
+
},
|
|
2481
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2482
|
+
security: [{ bearerAuth: [] }],
|
|
2483
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2484
|
+
type: "http",
|
|
2485
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2486
|
+
scheme: "bearer"
|
|
2487
|
+
} } },
|
|
2488
|
+
commonSchemas: {
|
|
2489
|
+
Submission: { schema: submissionSchema },
|
|
2490
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2491
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2492
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2493
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
2494
|
+
}
|
|
2495
|
+
};
|
|
2304
2496
|
//#endregion
|
|
2305
|
-
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 };
|
|
2497
|
+
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.gef36c2a",
|
|
4
4
|
"description": "Contract for the Alpic API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.mjs",
|
|
@@ -35,18 +35,18 @@
|
|
|
35
35
|
"dependencies": {
|
|
36
36
|
"@orpc/contract": "^1.15.0",
|
|
37
37
|
"ms": "^2.1.3",
|
|
38
|
-
"zod": "^4.4
|
|
38
|
+
"zod": "^4.5.4"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
|
+
"@alpic-ai/domains": "0.0.0",
|
|
41
42
|
"@orpc/openapi": "^1.15.0",
|
|
42
43
|
"@orpc/zod": "^1.15.0",
|
|
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.0"
|
|
50
50
|
},
|
|
51
51
|
"scripts": {
|
|
52
52
|
"build": "shx rm -rf dist && tsdown",
|