@alpic-ai/api 0.0.0-dev.gf80bbbb → 0.0.0-dev.gf813539
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 +5052 -42
- package/dist/index.mjs +376 -34
- 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,6 +257,25 @@ z.object({
|
|
|
256
257
|
clientSecret: z.string(),
|
|
257
258
|
clientScopes: z.array(z.string())
|
|
258
259
|
});
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"admin_adjustment"
|
|
266
|
+
]);
|
|
267
|
+
z.enum(["playground"]);
|
|
268
|
+
z.number().int().min(500);
|
|
269
|
+
const creditActivityEntrySchema = z.object({
|
|
270
|
+
reason: creditEntryReasonSchema,
|
|
271
|
+
day: z.number(),
|
|
272
|
+
amountInNanoUSD: z.number(),
|
|
273
|
+
messageCount: z.number().nullable()
|
|
274
|
+
});
|
|
275
|
+
z.object({
|
|
276
|
+
balanceInNanoUSD: z.number(),
|
|
277
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
278
|
+
});
|
|
259
279
|
const deploymentStatusSchema$1 = z.enum([
|
|
260
280
|
"ongoing",
|
|
261
281
|
"deployed",
|
|
@@ -424,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
424
444
|
"pink",
|
|
425
445
|
"gray"
|
|
426
446
|
]);
|
|
427
|
-
intentCategoryColorSchema.options;
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
428
448
|
const intentCategorySchema = z.object({
|
|
429
449
|
id: z.string(),
|
|
430
450
|
createdAt: z.coerce.date(),
|
|
@@ -432,7 +452,7 @@ const intentCategorySchema = z.object({
|
|
|
432
452
|
name: z.string(),
|
|
433
453
|
color: intentCategoryColorSchema
|
|
434
454
|
});
|
|
435
|
-
z.object({
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
436
456
|
id: z.string(),
|
|
437
457
|
name: z.string(),
|
|
438
458
|
color: intentCategoryColorSchema,
|
|
@@ -503,6 +523,16 @@ z.object({
|
|
|
503
523
|
createdAt: z.coerce.date(),
|
|
504
524
|
updatedAt: z.coerce.date()
|
|
505
525
|
});
|
|
526
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
527
|
+
type: z.literal("mcp_request"),
|
|
528
|
+
method: z.string()
|
|
529
|
+
});
|
|
530
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
531
|
+
type: z.literal("mcp_error"),
|
|
532
|
+
method: z.string(),
|
|
533
|
+
error: z.string()
|
|
534
|
+
});
|
|
535
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
506
536
|
z.enum([
|
|
507
537
|
"INFO",
|
|
508
538
|
"WARNING",
|
|
@@ -834,6 +864,10 @@ const clampStringField = (field) => {
|
|
|
834
864
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
835
865
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
836
866
|
};
|
|
867
|
+
const unboundedArrayField = (field) => {
|
|
868
|
+
const unbounded = z.array(field.element);
|
|
869
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
870
|
+
};
|
|
837
871
|
const toolDefinitionSchema = z.object({
|
|
838
872
|
name: z.string(),
|
|
839
873
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -846,11 +880,22 @@ const toolDefinitionSchema = z.object({
|
|
|
846
880
|
}).optional()
|
|
847
881
|
});
|
|
848
882
|
const positiveTestCaseSchema = z.object({
|
|
849
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
850
|
-
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."),
|
|
851
885
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
852
886
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
853
|
-
}).
|
|
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());
|
|
854
899
|
const screenshotEntrySchema = z.object({
|
|
855
900
|
prompt: z.string(),
|
|
856
901
|
url: z.url()
|
|
@@ -1163,9 +1208,18 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
1163
1208
|
"zh-TW"
|
|
1164
1209
|
]);
|
|
1165
1210
|
const negativeTestCaseSchema = z.object({
|
|
1166
|
-
scenario: z.string(),
|
|
1167
|
-
userPrompt: z.string()
|
|
1168
|
-
}).
|
|
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.");
|
|
1169
1223
|
const chatgptToolJustificationSchema = z.object({
|
|
1170
1224
|
toolName: z.string(),
|
|
1171
1225
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
@@ -1200,8 +1254,9 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
1200
1254
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
1201
1255
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1202
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."),
|
|
1203
|
-
|
|
1204
|
-
|
|
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."),
|
|
1205
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."),
|
|
1206
1261
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1207
1262
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
@@ -1216,23 +1271,35 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
1216
1271
|
demoRecordingUrl: z.string().optional(),
|
|
1217
1272
|
serverUrl: z.string().optional(),
|
|
1218
1273
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1274
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1275
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1219
1276
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1220
1277
|
});
|
|
1221
|
-
|
|
1278
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1279
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1222
1280
|
appName: true,
|
|
1223
1281
|
developerName: true,
|
|
1224
1282
|
serverUrl: true,
|
|
1225
1283
|
tools: true,
|
|
1284
|
+
skills: true,
|
|
1226
1285
|
authentication: true
|
|
1227
1286
|
});
|
|
1228
|
-
|
|
1287
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1288
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1229
1289
|
tagline: true,
|
|
1230
1290
|
description: true,
|
|
1231
1291
|
category: true,
|
|
1232
1292
|
testCases: true,
|
|
1233
1293
|
negativeTestCases: true,
|
|
1234
1294
|
toolJustifications: true
|
|
1235
|
-
}).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
|
+
});
|
|
1236
1303
|
const claudeCategorySchema = z.enum([
|
|
1237
1304
|
"Productivity",
|
|
1238
1305
|
"Communication",
|
|
@@ -1355,7 +1422,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1355
1422
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1356
1423
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1357
1424
|
});
|
|
1358
|
-
|
|
1425
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1426
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1359
1427
|
serverUrl: true,
|
|
1360
1428
|
name: true,
|
|
1361
1429
|
slug: true,
|
|
@@ -1377,33 +1445,81 @@ const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
|
1377
1445
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1378
1446
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1379
1447
|
});
|
|
1380
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1448
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1381
1449
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1382
1450
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1383
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
|
+
});
|
|
1384
1501
|
const submissionMetaFieldsSchema = z.object({
|
|
1385
1502
|
id: z.string(),
|
|
1386
1503
|
environmentId: z.string(),
|
|
1387
1504
|
auditId: z.string().nullable(),
|
|
1505
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1388
1506
|
createdAt: z.coerce.date(),
|
|
1389
1507
|
updatedAt: z.coerce.date()
|
|
1390
1508
|
});
|
|
1391
1509
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1392
1510
|
platform: z.literal("claudeai"),
|
|
1393
|
-
formData: claudeSubmissionDraftSchema
|
|
1511
|
+
formData: claudeSubmissionDraftSchema,
|
|
1512
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1394
1513
|
});
|
|
1395
1514
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1396
1515
|
platform: z.literal("chatgpt"),
|
|
1397
|
-
formData: chatgptSubmissionDraftSchema
|
|
1516
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1517
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1398
1518
|
});
|
|
1399
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1519
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1400
1520
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1401
|
-
|
|
1402
|
-
|
|
1403
|
-
pro: 2e5,
|
|
1404
|
-
business: 2e6,
|
|
1405
|
-
enterprise: null
|
|
1406
|
-
}).free;
|
|
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;
|
|
1407
1523
|
z.literal([
|
|
1408
1524
|
100,
|
|
1409
1525
|
75,
|
|
@@ -1420,18 +1536,70 @@ const customerCreditsSchema = z.object({
|
|
|
1420
1536
|
expiresAt: z.number().nullable(),
|
|
1421
1537
|
currency: z.string()
|
|
1422
1538
|
});
|
|
1423
|
-
const customerUsageSchema = z.object({
|
|
1424
|
-
amountInCents: z.number(),
|
|
1425
|
-
currency: z.string(),
|
|
1426
|
-
periodEnd: z.number()
|
|
1427
|
-
});
|
|
1428
1539
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1429
|
-
z.object({ balanceInNanoUSD: z.number() });
|
|
1430
1540
|
z.object({
|
|
1431
1541
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1432
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1433
1542
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1434
1543
|
});
|
|
1544
|
+
const metricsQueueEventSchema = z.object({
|
|
1545
|
+
ts: z.number().int(),
|
|
1546
|
+
method: z.string(),
|
|
1547
|
+
tool: z.string().nullable(),
|
|
1548
|
+
client: z.string(),
|
|
1549
|
+
sessionId: z.string().nullable(),
|
|
1550
|
+
durationMs: z.number().int(),
|
|
1551
|
+
outputTokens: z.number().int().nullable(),
|
|
1552
|
+
errorType: z.enum([
|
|
1553
|
+
"mcp_error",
|
|
1554
|
+
"tool_error",
|
|
1555
|
+
"timeout"
|
|
1556
|
+
]).nullable(),
|
|
1557
|
+
errorCode: z.number().int().nullable()
|
|
1558
|
+
});
|
|
1559
|
+
z.object({
|
|
1560
|
+
v: z.literal(1),
|
|
1561
|
+
envId: z.string(),
|
|
1562
|
+
events: z.array(metricsQueueEventSchema)
|
|
1563
|
+
});
|
|
1564
|
+
z.object({ v: z.number() });
|
|
1565
|
+
const telemetrySignalSchema = z.enum([
|
|
1566
|
+
"logs",
|
|
1567
|
+
"metrics",
|
|
1568
|
+
"traces"
|
|
1569
|
+
]);
|
|
1570
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1571
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1572
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1573
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1574
|
+
const otlpHeaderValueSchema = z.string().trim().max(OTLP_HEADER_VALUE_MAX_LENGTH).refine((value) => !/[\r\n]/.test(value), "Line breaks are not allowed in a header value");
|
|
1575
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1576
|
+
id: z.string(),
|
|
1577
|
+
name: otlpHeaderNameSchema,
|
|
1578
|
+
value: otlpHeaderValueSchema,
|
|
1579
|
+
isSecret: z.boolean()
|
|
1580
|
+
});
|
|
1581
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1582
|
+
"credentials",
|
|
1583
|
+
"wrong-path",
|
|
1584
|
+
"wrong-protocol",
|
|
1585
|
+
"invalid-payload",
|
|
1586
|
+
"partial-rejection",
|
|
1587
|
+
"blocked-target",
|
|
1588
|
+
"timeout",
|
|
1589
|
+
"unreachable",
|
|
1590
|
+
"receiver-error",
|
|
1591
|
+
"unexpected-status"
|
|
1592
|
+
]);
|
|
1593
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1594
|
+
z.object({
|
|
1595
|
+
id: z.string(),
|
|
1596
|
+
signal: telemetrySignalSchema,
|
|
1597
|
+
endpoint: otlpEndpointSchema,
|
|
1598
|
+
protocol: otlpProtocolSchema,
|
|
1599
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1600
|
+
status: telemetryDestinationStatusSchema,
|
|
1601
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1602
|
+
});
|
|
1435
1603
|
//#endregion
|
|
1436
1604
|
//#region src/auth-scope.ts
|
|
1437
1605
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1530,6 +1698,14 @@ const serverFieldsSchema = z.object({
|
|
|
1530
1698
|
});
|
|
1531
1699
|
//#endregion
|
|
1532
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
|
+
};
|
|
1533
1709
|
const deploymentStatusSchema = z.enum([
|
|
1534
1710
|
"ongoing",
|
|
1535
1711
|
"deployed",
|
|
@@ -1600,6 +1776,14 @@ const getEnvironmentContractV1 = base.route({
|
|
|
1600
1776
|
createdAt: z.coerce.date(),
|
|
1601
1777
|
projectId: z.string()
|
|
1602
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) }));
|
|
1603
1787
|
const domainSchema = z.object({
|
|
1604
1788
|
domain: z.string(),
|
|
1605
1789
|
status: z.enum([
|
|
@@ -1912,7 +2096,7 @@ const getProjectAnalyticsContractV1 = base.route({
|
|
|
1912
2096
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1913
2097
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1914
2098
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1915
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2099
|
+
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 26784e5, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => isValidIanaTimeZone(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
1916
2100
|
metadata: z.object({
|
|
1917
2101
|
startTimestamp: z.number(),
|
|
1918
2102
|
endTimestamp: z.number(),
|
|
@@ -1976,6 +2160,77 @@ const listFeedbacksContractV1 = base.route({
|
|
|
1976
2160
|
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
1977
2161
|
totalCount: z.number().int().nonnegative()
|
|
1978
2162
|
}));
|
|
2163
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2164
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2165
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2166
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2167
|
+
method: "GET",
|
|
2168
|
+
summary: "List intent categories",
|
|
2169
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2170
|
+
tags: ["insights"],
|
|
2171
|
+
successDescription: "The intent categories"
|
|
2172
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2173
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2174
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2175
|
+
method: "POST",
|
|
2176
|
+
summary: "Create an intent category",
|
|
2177
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2178
|
+
tags: ["insights"],
|
|
2179
|
+
successDescription: "The created intent category"
|
|
2180
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2181
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2182
|
+
name: intentCategoryNameSchema,
|
|
2183
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2184
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2185
|
+
})).output(intentCategorySchema);
|
|
2186
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2187
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2188
|
+
method: "PATCH",
|
|
2189
|
+
summary: "Update an intent category",
|
|
2190
|
+
description: "Rename or recolor an intent category",
|
|
2191
|
+
tags: ["insights"],
|
|
2192
|
+
successDescription: "The updated intent category"
|
|
2193
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2194
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2195
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2196
|
+
name: intentCategoryNameSchema.optional(),
|
|
2197
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2198
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2199
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2200
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2201
|
+
method: "DELETE",
|
|
2202
|
+
summary: "Delete an intent category",
|
|
2203
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2204
|
+
tags: ["insights"],
|
|
2205
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2206
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2207
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2208
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2209
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2210
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2211
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2212
|
+
method: "POST",
|
|
2213
|
+
summary: "Link an intent category",
|
|
2214
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2215
|
+
tags: ["insights"],
|
|
2216
|
+
successDescription: "The intents have been linked successfully"
|
|
2217
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2218
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2219
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2220
|
+
intentIds: categorizableIntentIdsSchema
|
|
2221
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2222
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2223
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2224
|
+
method: "POST",
|
|
2225
|
+
summary: "Unlink an intent category",
|
|
2226
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2227
|
+
tags: ["insights"],
|
|
2228
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2229
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2230
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2231
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2232
|
+
intentIds: categorizableIntentIdsSchema
|
|
2233
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
1979
2234
|
const listTeamsContractV1 = base.route({
|
|
1980
2235
|
path: "/v1/teams",
|
|
1981
2236
|
method: "GET",
|
|
@@ -2111,6 +2366,57 @@ const getBeaconContractV1 = base.route({
|
|
|
2111
2366
|
createdAt: z.coerce.date(),
|
|
2112
2367
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
2113
2368
|
}));
|
|
2369
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2370
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2371
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2372
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2373
|
+
const createSubmissionContractV1 = base.route({
|
|
2374
|
+
path: "/v1/submissions",
|
|
2375
|
+
method: "POST",
|
|
2376
|
+
summary: "Create a submission package",
|
|
2377
|
+
description: "Create a submission package for an environment. Alpic reads the environment's live MCP server and prefills every field it can infer, so the response already carries the populated package. The environment must have a successful deployment and must not require authentication.",
|
|
2378
|
+
tags: ["submissions"],
|
|
2379
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2380
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2381
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2382
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2383
|
+
})).output(submissionSchema);
|
|
2384
|
+
const listSubmissionsContractV1 = base.route({
|
|
2385
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2386
|
+
method: "GET",
|
|
2387
|
+
summary: "List submission packages",
|
|
2388
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2389
|
+
tags: ["submissions"],
|
|
2390
|
+
successDescription: "The list of submission packages"
|
|
2391
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2392
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2393
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2394
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2395
|
+
})).output(z.array(submissionSchema));
|
|
2396
|
+
const getSubmissionContractV1 = base.route({
|
|
2397
|
+
path: "/v1/submissions/{submissionId}",
|
|
2398
|
+
method: "GET",
|
|
2399
|
+
summary: "Get a submission package",
|
|
2400
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2401
|
+
tags: ["submissions"],
|
|
2402
|
+
successDescription: "The submission package"
|
|
2403
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2404
|
+
const updateSubmissionContractV1 = base.route({
|
|
2405
|
+
path: "/v1/submissions/{submissionId}",
|
|
2406
|
+
method: "PUT",
|
|
2407
|
+
summary: "Update a submission package",
|
|
2408
|
+
description: "Update the form data of a submission package. Only the fields you send are changed; the rest are left as they are. Unknown field names are rejected rather than ignored, so a typo fails the call. `platform` must match the package's own platform.",
|
|
2409
|
+
tags: ["submissions"],
|
|
2410
|
+
successDescription: "The updated submission package"
|
|
2411
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2412
|
+
submissionId: submissionIdSchema,
|
|
2413
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2414
|
+
formData: claudeSubmissionUpdateSchema
|
|
2415
|
+
}), z.object({
|
|
2416
|
+
submissionId: submissionIdSchema,
|
|
2417
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2418
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2419
|
+
})])).output(submissionSchema);
|
|
2114
2420
|
const contract = {
|
|
2115
2421
|
teams: {
|
|
2116
2422
|
list: { v1: listTeamsContractV1 },
|
|
@@ -2118,6 +2424,14 @@ const contract = {
|
|
|
2118
2424
|
},
|
|
2119
2425
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2120
2426
|
intents: { list: { v1: listIntentsContractV1 } },
|
|
2427
|
+
intentCategories: {
|
|
2428
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2429
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2430
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2431
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2432
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2433
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2434
|
+
},
|
|
2121
2435
|
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
2122
2436
|
deployments: {
|
|
2123
2437
|
list: { v1: listDeploymentsContractV1 },
|
|
@@ -2128,6 +2442,7 @@ const contract = {
|
|
|
2128
2442
|
environments: {
|
|
2129
2443
|
create: { v1: createEnvironmentContractV1 },
|
|
2130
2444
|
get: { v1: getEnvironmentContractV1 },
|
|
2445
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
2131
2446
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
2132
2447
|
getLogs: { v1: getLogsContractV1 },
|
|
2133
2448
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -2157,6 +2472,12 @@ const contract = {
|
|
|
2157
2472
|
beacon: {
|
|
2158
2473
|
create: { v1: createBeaconContractV1 },
|
|
2159
2474
|
get: { v1: getBeaconContractV1 }
|
|
2475
|
+
},
|
|
2476
|
+
submissions: {
|
|
2477
|
+
create: { v1: createSubmissionContractV1 },
|
|
2478
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2479
|
+
get: { v1: getSubmissionContractV1 },
|
|
2480
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2160
2481
|
}
|
|
2161
2482
|
};
|
|
2162
2483
|
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
@@ -2164,5 +2485,26 @@ const contractForDocs = {
|
|
|
2164
2485
|
...contract,
|
|
2165
2486
|
deployments: deploymentsForDocs
|
|
2166
2487
|
};
|
|
2488
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2489
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2490
|
+
info: {
|
|
2491
|
+
title: "Alpic API",
|
|
2492
|
+
version: "1.0.0"
|
|
2493
|
+
},
|
|
2494
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2495
|
+
security: [{ bearerAuth: [] }],
|
|
2496
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2497
|
+
type: "http",
|
|
2498
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2499
|
+
scheme: "bearer"
|
|
2500
|
+
} } },
|
|
2501
|
+
commonSchemas: {
|
|
2502
|
+
Submission: { schema: submissionSchema },
|
|
2503
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2504
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2505
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2506
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
2507
|
+
}
|
|
2508
|
+
};
|
|
2167
2509
|
//#endregion
|
|
2168
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2510
|
+
export { AI_PLATFORMS, AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, OPENAPI_DOC_OPTIONS, PLATFORM_LABELS, buildSettingsSchema, chatgptSubmissionUpdateSchema, claudeSubmissionUpdateSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
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.gf813539",
|
|
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",
|