@alpic-ai/api 0.0.0-staging.geba2a69 → 0.0.0-staging.ged009c5
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 +4781 -55
- package/dist/index.mjs +217 -29
- package/package.json +6 -6
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.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.1_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
|
*/
|
|
@@ -420,7 +420,8 @@ z.object({
|
|
|
420
420
|
collectResponsePayload: z.boolean(),
|
|
421
421
|
collectErrorMessage: z.boolean(),
|
|
422
422
|
collectUserData: z.boolean(),
|
|
423
|
-
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
423
|
+
identityTraitKey: z.string().min(1).max(200).nullable(),
|
|
424
|
+
leadEventName: z.string().min(1).max(200).nullable()
|
|
424
425
|
});
|
|
425
426
|
const feedbackSchema = z.object({
|
|
426
427
|
id: z.string(),
|
|
@@ -539,6 +540,14 @@ z.enum([
|
|
|
539
540
|
"DEBUG",
|
|
540
541
|
"ERROR"
|
|
541
542
|
]);
|
|
543
|
+
const LOG_SEARCH_MAX_ESCAPED_LENGTH = 960;
|
|
544
|
+
function escapeLogSearchTerm(search) {
|
|
545
|
+
return [...search].flatMap((character) => [...new TextEncoder().encode(character)]).map((byte) => {
|
|
546
|
+
const character = String.fromCharCode(byte);
|
|
547
|
+
return /^[a-zA-Z0-9]$/.test(character) ? character : `\\x${byte.toString(16).toUpperCase().padStart(2, "0")}`;
|
|
548
|
+
}).join("");
|
|
549
|
+
}
|
|
550
|
+
const logSearchSchema = z.string().max(240, `Search must be 240 characters or fewer`).refine((search) => escapeLogSearchTerm(search).length <= LOG_SEARCH_MAX_ESCAPED_LENGTH, "Search is too complex; shorten it or use fewer special characters");
|
|
542
551
|
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
543
552
|
const MCP_CLIENT_GROUPS = [
|
|
544
553
|
{
|
|
@@ -864,6 +873,10 @@ const clampStringField = (field) => {
|
|
|
864
873
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
865
874
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
866
875
|
};
|
|
876
|
+
const unboundedArrayField = (field) => {
|
|
877
|
+
const unbounded = z.array(field.element);
|
|
878
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
879
|
+
};
|
|
867
880
|
const toolDefinitionSchema = z.object({
|
|
868
881
|
name: z.string(),
|
|
869
882
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -876,11 +889,22 @@ const toolDefinitionSchema = z.object({
|
|
|
876
889
|
}).optional()
|
|
877
890
|
});
|
|
878
891
|
const positiveTestCaseSchema = z.object({
|
|
879
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
880
|
-
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."),
|
|
892
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
893
|
+
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."),
|
|
881
894
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
882
895
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
883
|
-
}).
|
|
896
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
897
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
898
|
+
scenario: z.string().optional(),
|
|
899
|
+
userPrompt: z.string().optional()
|
|
900
|
+
});
|
|
901
|
+
const blankPositiveTestCase = () => ({
|
|
902
|
+
scenario: "",
|
|
903
|
+
userPrompt: "",
|
|
904
|
+
toolTriggered: "",
|
|
905
|
+
expectedOutput: ""
|
|
906
|
+
});
|
|
907
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
884
908
|
const screenshotEntrySchema = z.object({
|
|
885
909
|
prompt: z.string(),
|
|
886
910
|
url: z.url()
|
|
@@ -1193,9 +1217,18 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
1193
1217
|
"zh-TW"
|
|
1194
1218
|
]);
|
|
1195
1219
|
const negativeTestCaseSchema = z.object({
|
|
1196
|
-
scenario: z.string(),
|
|
1197
|
-
userPrompt: z.string()
|
|
1198
|
-
}).
|
|
1220
|
+
scenario: z.string().min(1),
|
|
1221
|
+
userPrompt: z.string().min(1)
|
|
1222
|
+
}).describe("Each case: Scenario + User prompt (the plugin should NOT trigger).");
|
|
1223
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1224
|
+
scenario: z.string().optional(),
|
|
1225
|
+
userPrompt: z.string().optional()
|
|
1226
|
+
});
|
|
1227
|
+
const blankNegativeTestCase = () => ({
|
|
1228
|
+
scenario: "",
|
|
1229
|
+
userPrompt: ""
|
|
1230
|
+
});
|
|
1231
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
1199
1232
|
const chatgptToolJustificationSchema = z.object({
|
|
1200
1233
|
toolName: z.string(),
|
|
1201
1234
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
@@ -1215,27 +1248,28 @@ chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema
|
|
|
1215
1248
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
1216
1249
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
1217
1250
|
logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
|
|
1218
|
-
appName: z.string().describe("The name users will see in ChatGPT and in the
|
|
1251
|
+
appName: z.string().describe("The name users will see in ChatGPT and in the Plugin Directory."),
|
|
1219
1252
|
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
1220
|
-
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the
|
|
1253
|
+
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the plugin does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the plugin does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
|
|
1221
1254
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
1222
|
-
developerName: z.string().describe("Developer name shown publicly on the
|
|
1255
|
+
developerName: z.string().describe("Developer name shown publicly on the plugin's directory page."),
|
|
1223
1256
|
companyUrl: urlField.describe("Your company's main website URL."),
|
|
1224
1257
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
1225
1258
|
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1226
|
-
termsOfServiceUrl: urlField.describe("URL to the
|
|
1227
|
-
demoRecordingUrl: urlField.describe("URL to a video demonstrating the
|
|
1228
|
-
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My
|
|
1259
|
+
termsOfServiceUrl: urlField.describe("URL to the plugin's terms of service."),
|
|
1260
|
+
demoRecordingUrl: urlField.describe("URL to a video demonstrating the plugin, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
1261
|
+
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My plugin links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the plugin does not offer digital goods."),
|
|
1229
1262
|
serverUrl: urlField.describe("URL of the MCP server."),
|
|
1230
1263
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
1231
1264
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1232
1265
|
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."),
|
|
1233
|
-
|
|
1234
|
-
|
|
1235
|
-
|
|
1266
|
+
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."),
|
|
1267
|
+
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."),
|
|
1268
|
+
negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 3 negative test cases: prompts where the plugin 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 plugin does not carry, the right brand or domain but an intent the plugin does not serve, or a boundary with a sibling plugin."),
|
|
1269
|
+
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-plugin screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget plugins must show the widget UI; non-widget plugins show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
1236
1270
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1237
1271
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
1238
|
-
releaseNotes: z.string().describe("Publicly displayed on the
|
|
1272
|
+
releaseNotes: z.string().describe("Publicly displayed on the plugin details page.")
|
|
1239
1273
|
});
|
|
1240
1274
|
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1241
1275
|
tagline: z.string().optional(),
|
|
@@ -1246,23 +1280,35 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
1246
1280
|
demoRecordingUrl: z.string().optional(),
|
|
1247
1281
|
serverUrl: z.string().optional(),
|
|
1248
1282
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1283
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1284
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1249
1285
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1250
1286
|
});
|
|
1251
|
-
|
|
1287
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1288
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1252
1289
|
appName: true,
|
|
1253
1290
|
developerName: true,
|
|
1254
1291
|
serverUrl: true,
|
|
1255
1292
|
tools: true,
|
|
1293
|
+
skills: true,
|
|
1256
1294
|
authentication: true
|
|
1257
1295
|
});
|
|
1258
|
-
|
|
1296
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1297
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1259
1298
|
tagline: true,
|
|
1260
1299
|
description: true,
|
|
1261
1300
|
category: true,
|
|
1262
1301
|
testCases: true,
|
|
1263
1302
|
negativeTestCases: true,
|
|
1264
1303
|
toolJustifications: true
|
|
1265
|
-
}).extend({
|
|
1304
|
+
}).extend({
|
|
1305
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1306
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1307
|
+
}).extend({
|
|
1308
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1309
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1310
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1311
|
+
});
|
|
1266
1312
|
const claudeCategorySchema = z.enum([
|
|
1267
1313
|
"Productivity",
|
|
1268
1314
|
"Communication",
|
|
@@ -1385,7 +1431,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1385
1431
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1386
1432
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1387
1433
|
});
|
|
1388
|
-
|
|
1434
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1435
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1389
1436
|
serverUrl: true,
|
|
1390
1437
|
name: true,
|
|
1391
1438
|
slug: true,
|
|
@@ -1407,27 +1454,81 @@ const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
|
1407
1454
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1408
1455
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1409
1456
|
});
|
|
1410
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1457
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1411
1458
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1412
1459
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1413
1460
|
});
|
|
1461
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1462
|
+
const byField = {};
|
|
1463
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1464
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1465
|
+
return byField;
|
|
1466
|
+
}
|
|
1467
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1468
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1469
|
+
"pass",
|
|
1470
|
+
"fail",
|
|
1471
|
+
"unverified"
|
|
1472
|
+
]);
|
|
1473
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1474
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1475
|
+
claudeai: ["privacyPolicy"]
|
|
1476
|
+
};
|
|
1477
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1478
|
+
const policyDisclosureSchema = z.enum([
|
|
1479
|
+
"dataCategories",
|
|
1480
|
+
"purposesOfUse",
|
|
1481
|
+
"recipients",
|
|
1482
|
+
"retention"
|
|
1483
|
+
]);
|
|
1484
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1485
|
+
field: verifiableUrlFieldSchema,
|
|
1486
|
+
url: z.string(),
|
|
1487
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1488
|
+
reason: z.string(),
|
|
1489
|
+
concerns: z.array(z.string()).optional(),
|
|
1490
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1491
|
+
});
|
|
1492
|
+
const urlVerificationSchema = z.object({
|
|
1493
|
+
verifiedAt: z.coerce.date(),
|
|
1494
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1495
|
+
});
|
|
1496
|
+
const pageKindSchema = z.enum([
|
|
1497
|
+
"expectedDocument",
|
|
1498
|
+
"errorPage",
|
|
1499
|
+
"loginWall",
|
|
1500
|
+
"parkedDomain",
|
|
1501
|
+
"comingSoon",
|
|
1502
|
+
"marketingPage",
|
|
1503
|
+
"unrelatedDocument"
|
|
1504
|
+
]);
|
|
1505
|
+
z.object({
|
|
1506
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1507
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1508
|
+
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.")
|
|
1509
|
+
});
|
|
1414
1510
|
const submissionMetaFieldsSchema = z.object({
|
|
1415
1511
|
id: z.string(),
|
|
1416
1512
|
environmentId: z.string(),
|
|
1417
1513
|
auditId: z.string().nullable(),
|
|
1514
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1418
1515
|
createdAt: z.coerce.date(),
|
|
1419
1516
|
updatedAt: z.coerce.date()
|
|
1420
1517
|
});
|
|
1421
1518
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1422
1519
|
platform: z.literal("claudeai"),
|
|
1423
|
-
formData: claudeSubmissionDraftSchema
|
|
1520
|
+
formData: claudeSubmissionDraftSchema,
|
|
1521
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1424
1522
|
});
|
|
1425
1523
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1426
1524
|
platform: z.literal("chatgpt"),
|
|
1427
|
-
formData: chatgptSubmissionDraftSchema
|
|
1525
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1526
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1428
1527
|
});
|
|
1429
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1528
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1430
1529
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1530
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1531
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1431
1532
|
z.literal([
|
|
1432
1533
|
100,
|
|
1433
1534
|
75,
|
|
@@ -1684,6 +1785,14 @@ const getEnvironmentContractV1 = base.route({
|
|
|
1684
1785
|
createdAt: z.coerce.date(),
|
|
1685
1786
|
projectId: z.string()
|
|
1686
1787
|
}));
|
|
1788
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1789
|
+
path: "/v1/environments/{environmentId}",
|
|
1790
|
+
method: "DELETE",
|
|
1791
|
+
summary: "Delete an environment",
|
|
1792
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1793
|
+
tags: ["environments"],
|
|
1794
|
+
successDescription: "The environment has been deleted successfully"
|
|
1795
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1687
1796
|
const domainSchema = z.object({
|
|
1688
1797
|
domain: z.string(),
|
|
1689
1798
|
status: z.enum([
|
|
@@ -1933,7 +2042,7 @@ const getLogsContractV1 = base.route({
|
|
|
1933
2042
|
"WARNING",
|
|
1934
2043
|
"DEBUG"
|
|
1935
2044
|
])).optional().describe("Filter by log level"),
|
|
1936
|
-
search:
|
|
2045
|
+
search: logSearchSchema.optional().describe("Term to search for in log content"),
|
|
1937
2046
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1938
2047
|
})).output(z.object({
|
|
1939
2048
|
logs: z.array(logEntrySchema),
|
|
@@ -1955,7 +2064,7 @@ const getLatestLogsContractV1 = base.route({
|
|
|
1955
2064
|
"WARNING",
|
|
1956
2065
|
"DEBUG"
|
|
1957
2066
|
])).optional().describe("Filter by log level"),
|
|
1958
|
-
search:
|
|
2067
|
+
search: logSearchSchema.optional().describe("Term to search for in log content")
|
|
1959
2068
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1960
2069
|
const getDeploymentLogsContractV1 = base.route({
|
|
1961
2070
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
@@ -2266,6 +2375,57 @@ const getBeaconContractV1 = base.route({
|
|
|
2266
2375
|
createdAt: z.coerce.date(),
|
|
2267
2376
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
2268
2377
|
}));
|
|
2378
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2379
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2380
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2381
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2382
|
+
const createSubmissionContractV1 = base.route({
|
|
2383
|
+
path: "/v1/submissions",
|
|
2384
|
+
method: "POST",
|
|
2385
|
+
summary: "Create a submission package",
|
|
2386
|
+
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.",
|
|
2387
|
+
tags: ["submissions"],
|
|
2388
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2389
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2390
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2391
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2392
|
+
})).output(submissionSchema);
|
|
2393
|
+
const listSubmissionsContractV1 = base.route({
|
|
2394
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2395
|
+
method: "GET",
|
|
2396
|
+
summary: "List submission packages",
|
|
2397
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2398
|
+
tags: ["submissions"],
|
|
2399
|
+
successDescription: "The list of submission packages"
|
|
2400
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2401
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2402
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2403
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2404
|
+
})).output(z.array(submissionSchema));
|
|
2405
|
+
const getSubmissionContractV1 = base.route({
|
|
2406
|
+
path: "/v1/submissions/{submissionId}",
|
|
2407
|
+
method: "GET",
|
|
2408
|
+
summary: "Get a submission package",
|
|
2409
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2410
|
+
tags: ["submissions"],
|
|
2411
|
+
successDescription: "The submission package"
|
|
2412
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2413
|
+
const updateSubmissionContractV1 = base.route({
|
|
2414
|
+
path: "/v1/submissions/{submissionId}",
|
|
2415
|
+
method: "PUT",
|
|
2416
|
+
summary: "Update a submission package",
|
|
2417
|
+
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.",
|
|
2418
|
+
tags: ["submissions"],
|
|
2419
|
+
successDescription: "The updated submission package"
|
|
2420
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2421
|
+
submissionId: submissionIdSchema,
|
|
2422
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2423
|
+
formData: claudeSubmissionUpdateSchema
|
|
2424
|
+
}), z.object({
|
|
2425
|
+
submissionId: submissionIdSchema,
|
|
2426
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2427
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2428
|
+
})])).output(submissionSchema);
|
|
2269
2429
|
const contract = {
|
|
2270
2430
|
teams: {
|
|
2271
2431
|
list: { v1: listTeamsContractV1 },
|
|
@@ -2291,6 +2451,7 @@ const contract = {
|
|
|
2291
2451
|
environments: {
|
|
2292
2452
|
create: { v1: createEnvironmentContractV1 },
|
|
2293
2453
|
get: { v1: getEnvironmentContractV1 },
|
|
2454
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
2294
2455
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
2295
2456
|
getLogs: { v1: getLogsContractV1 },
|
|
2296
2457
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -2320,6 +2481,12 @@ const contract = {
|
|
|
2320
2481
|
beacon: {
|
|
2321
2482
|
create: { v1: createBeaconContractV1 },
|
|
2322
2483
|
get: { v1: getBeaconContractV1 }
|
|
2484
|
+
},
|
|
2485
|
+
submissions: {
|
|
2486
|
+
create: { v1: createSubmissionContractV1 },
|
|
2487
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2488
|
+
get: { v1: getSubmissionContractV1 },
|
|
2489
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2323
2490
|
}
|
|
2324
2491
|
};
|
|
2325
2492
|
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
@@ -2327,5 +2494,26 @@ const contractForDocs = {
|
|
|
2327
2494
|
...contract,
|
|
2328
2495
|
deployments: deploymentsForDocs
|
|
2329
2496
|
};
|
|
2497
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2498
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2499
|
+
info: {
|
|
2500
|
+
title: "Alpic API",
|
|
2501
|
+
version: "1.0.0"
|
|
2502
|
+
},
|
|
2503
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2504
|
+
security: [{ bearerAuth: [] }],
|
|
2505
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2506
|
+
type: "http",
|
|
2507
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2508
|
+
scheme: "bearer"
|
|
2509
|
+
} } },
|
|
2510
|
+
commonSchemas: {
|
|
2511
|
+
Submission: { schema: submissionSchema },
|
|
2512
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2513
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2514
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2515
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
2516
|
+
}
|
|
2517
|
+
};
|
|
2330
2518
|
//#endregion
|
|
2331
|
-
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 };
|
|
2519
|
+
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-staging.
|
|
3
|
+
"version": "0.0.0-staging.ged009c5",
|
|
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.4",
|
|
37
37
|
"ms": "^2.1.3",
|
|
38
38
|
"zod": "^4.5.4"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
41
|
"@alpic-ai/domains": "0.0.0",
|
|
42
|
-
"@orpc/openapi": "^1.15.
|
|
43
|
-
"@orpc/zod": "^1.15.
|
|
42
|
+
"@orpc/openapi": "^1.15.4",
|
|
43
|
+
"@orpc/zod": "^1.15.4",
|
|
44
44
|
"@total-typescript/tsconfig": "^1.0.4",
|
|
45
45
|
"@types/ms": "^2.1.0",
|
|
46
46
|
"shx": "^0.4.0",
|
|
47
|
-
"tsdown": "^0.
|
|
47
|
+
"tsdown": "^0.23.0",
|
|
48
48
|
"typescript": "^6.0.3",
|
|
49
|
-
"vitest": "^
|
|
49
|
+
"vitest": "^5.0.2"
|
|
50
50
|
},
|
|
51
51
|
"scripts": {
|
|
52
52
|
"build": "shx rm -rf dist && tsdown",
|