@alpic-ai/api 0.0.0-dev.gd9e9ea8 → 0.0.0-dev.gd9ebdf8
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 +266 -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
|
];
|
|
@@ -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",
|
|
@@ -1484,6 +1600,32 @@ z.object({
|
|
|
1484
1600
|
status: telemetryDestinationStatusSchema,
|
|
1485
1601
|
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1486
1602
|
});
|
|
1603
|
+
const webhookEventSchema = z.enum([
|
|
1604
|
+
"deployment.succeeded",
|
|
1605
|
+
"deployment.failed",
|
|
1606
|
+
"deployment.canceled"
|
|
1607
|
+
]);
|
|
1608
|
+
const webhookDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1609
|
+
const webhookDeliveryFailureReasonSchema = z.enum([
|
|
1610
|
+
"credentials",
|
|
1611
|
+
"blocked-target",
|
|
1612
|
+
"timeout",
|
|
1613
|
+
"unreachable",
|
|
1614
|
+
"receiver-error",
|
|
1615
|
+
"unexpected-status"
|
|
1616
|
+
]);
|
|
1617
|
+
const webhookUrlSchema = z.url({
|
|
1618
|
+
protocol: /^https$/,
|
|
1619
|
+
error: "Enter a valid HTTPS URL"
|
|
1620
|
+
}).max(2048, "Webhook URL must be at most 2048 characters");
|
|
1621
|
+
const webhookEventsSchema = z.array(webhookEventSchema).min(1, "Select at least one event").refine((events) => new Set(events).size === events.length, "Events must be unique");
|
|
1622
|
+
z.object({
|
|
1623
|
+
id: z.string(),
|
|
1624
|
+
url: webhookUrlSchema,
|
|
1625
|
+
events: webhookEventsSchema,
|
|
1626
|
+
status: webhookDestinationStatusSchema,
|
|
1627
|
+
lastFailureReason: webhookDeliveryFailureReasonSchema.nullable()
|
|
1628
|
+
}).extend({ secret: z.string().min(1) });
|
|
1487
1629
|
//#endregion
|
|
1488
1630
|
//#region src/auth-scope.ts
|
|
1489
1631
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1582,6 +1724,14 @@ const serverFieldsSchema = z.object({
|
|
|
1582
1724
|
});
|
|
1583
1725
|
//#endregion
|
|
1584
1726
|
//#region src/api.contract.ts
|
|
1727
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1728
|
+
try {
|
|
1729
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1730
|
+
return true;
|
|
1731
|
+
} catch {
|
|
1732
|
+
return false;
|
|
1733
|
+
}
|
|
1734
|
+
};
|
|
1585
1735
|
const deploymentStatusSchema = z.enum([
|
|
1586
1736
|
"ongoing",
|
|
1587
1737
|
"deployed",
|
|
@@ -1652,6 +1802,14 @@ const getEnvironmentContractV1 = base.route({
|
|
|
1652
1802
|
createdAt: z.coerce.date(),
|
|
1653
1803
|
projectId: z.string()
|
|
1654
1804
|
}));
|
|
1805
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1806
|
+
path: "/v1/environments/{environmentId}",
|
|
1807
|
+
method: "DELETE",
|
|
1808
|
+
summary: "Delete an environment",
|
|
1809
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1810
|
+
tags: ["environments"],
|
|
1811
|
+
successDescription: "The environment has been deleted successfully"
|
|
1812
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1655
1813
|
const domainSchema = z.object({
|
|
1656
1814
|
domain: z.string(),
|
|
1657
1815
|
status: z.enum([
|
|
@@ -1964,7 +2122,7 @@ const getProjectAnalyticsContractV1 = base.route({
|
|
|
1964
2122
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1965
2123
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1966
2124
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1967
|
-
}).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 }) =>
|
|
2125
|
+
}).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({
|
|
1968
2126
|
metadata: z.object({
|
|
1969
2127
|
startTimestamp: z.number(),
|
|
1970
2128
|
endTimestamp: z.number(),
|
|
@@ -2234,6 +2392,57 @@ const getBeaconContractV1 = base.route({
|
|
|
2234
2392
|
createdAt: z.coerce.date(),
|
|
2235
2393
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
2236
2394
|
}));
|
|
2395
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2396
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2397
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2398
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2399
|
+
const createSubmissionContractV1 = base.route({
|
|
2400
|
+
path: "/v1/submissions",
|
|
2401
|
+
method: "POST",
|
|
2402
|
+
summary: "Create a submission package",
|
|
2403
|
+
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.",
|
|
2404
|
+
tags: ["submissions"],
|
|
2405
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2406
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2407
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2408
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2409
|
+
})).output(submissionSchema);
|
|
2410
|
+
const listSubmissionsContractV1 = base.route({
|
|
2411
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2412
|
+
method: "GET",
|
|
2413
|
+
summary: "List submission packages",
|
|
2414
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2415
|
+
tags: ["submissions"],
|
|
2416
|
+
successDescription: "The list of submission packages"
|
|
2417
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2418
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2419
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2420
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2421
|
+
})).output(z.array(submissionSchema));
|
|
2422
|
+
const getSubmissionContractV1 = base.route({
|
|
2423
|
+
path: "/v1/submissions/{submissionId}",
|
|
2424
|
+
method: "GET",
|
|
2425
|
+
summary: "Get a submission package",
|
|
2426
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2427
|
+
tags: ["submissions"],
|
|
2428
|
+
successDescription: "The submission package"
|
|
2429
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2430
|
+
const updateSubmissionContractV1 = base.route({
|
|
2431
|
+
path: "/v1/submissions/{submissionId}",
|
|
2432
|
+
method: "PUT",
|
|
2433
|
+
summary: "Update a submission package",
|
|
2434
|
+
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.",
|
|
2435
|
+
tags: ["submissions"],
|
|
2436
|
+
successDescription: "The updated submission package"
|
|
2437
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2438
|
+
submissionId: submissionIdSchema,
|
|
2439
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2440
|
+
formData: claudeSubmissionUpdateSchema
|
|
2441
|
+
}), z.object({
|
|
2442
|
+
submissionId: submissionIdSchema,
|
|
2443
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2444
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2445
|
+
})])).output(submissionSchema);
|
|
2237
2446
|
const contract = {
|
|
2238
2447
|
teams: {
|
|
2239
2448
|
list: { v1: listTeamsContractV1 },
|
|
@@ -2259,6 +2468,7 @@ const contract = {
|
|
|
2259
2468
|
environments: {
|
|
2260
2469
|
create: { v1: createEnvironmentContractV1 },
|
|
2261
2470
|
get: { v1: getEnvironmentContractV1 },
|
|
2471
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
2262
2472
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
2263
2473
|
getLogs: { v1: getLogsContractV1 },
|
|
2264
2474
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -2288,6 +2498,12 @@ const contract = {
|
|
|
2288
2498
|
beacon: {
|
|
2289
2499
|
create: { v1: createBeaconContractV1 },
|
|
2290
2500
|
get: { v1: getBeaconContractV1 }
|
|
2501
|
+
},
|
|
2502
|
+
submissions: {
|
|
2503
|
+
create: { v1: createSubmissionContractV1 },
|
|
2504
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2505
|
+
get: { v1: getSubmissionContractV1 },
|
|
2506
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2291
2507
|
}
|
|
2292
2508
|
};
|
|
2293
2509
|
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
@@ -2295,5 +2511,26 @@ const contractForDocs = {
|
|
|
2295
2511
|
...contract,
|
|
2296
2512
|
deployments: deploymentsForDocs
|
|
2297
2513
|
};
|
|
2514
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2515
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2516
|
+
info: {
|
|
2517
|
+
title: "Alpic API",
|
|
2518
|
+
version: "1.0.0"
|
|
2519
|
+
},
|
|
2520
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2521
|
+
security: [{ bearerAuth: [] }],
|
|
2522
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2523
|
+
type: "http",
|
|
2524
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2525
|
+
scheme: "bearer"
|
|
2526
|
+
} } },
|
|
2527
|
+
commonSchemas: {
|
|
2528
|
+
Submission: { schema: submissionSchema },
|
|
2529
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2530
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2531
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2532
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
2533
|
+
}
|
|
2534
|
+
};
|
|
2298
2535
|
//#endregion
|
|
2299
|
-
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 };
|
|
2536
|
+
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.gd9ebdf8",
|
|
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",
|