@alpic-ai/api 1.171.0 → 1.172.0
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 +4729 -53
- package/dist/index.mjs +123 -4
- package/package.json +3 -3
package/dist/index.mjs
CHANGED
|
@@ -885,7 +885,10 @@ const positiveTestCaseSchema = z.object({
|
|
|
885
885
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
886
886
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
887
887
|
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
888
|
-
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial()
|
|
888
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
889
|
+
scenario: z.string().optional(),
|
|
890
|
+
userPrompt: z.string().optional()
|
|
891
|
+
});
|
|
889
892
|
const blankPositiveTestCase = () => ({
|
|
890
893
|
scenario: "",
|
|
891
894
|
userPrompt: "",
|
|
@@ -1208,11 +1211,15 @@ const negativeTestCaseSchema = z.object({
|
|
|
1208
1211
|
scenario: z.string().min(1),
|
|
1209
1212
|
userPrompt: z.string().min(1)
|
|
1210
1213
|
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1211
|
-
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial()
|
|
1214
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1215
|
+
scenario: z.string().optional(),
|
|
1216
|
+
userPrompt: z.string().optional()
|
|
1217
|
+
});
|
|
1212
1218
|
const blankNegativeTestCase = () => ({
|
|
1213
1219
|
scenario: "",
|
|
1214
1220
|
userPrompt: ""
|
|
1215
1221
|
});
|
|
1222
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
1216
1223
|
const chatgptToolJustificationSchema = z.object({
|
|
1217
1224
|
toolName: z.string(),
|
|
1218
1225
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
@@ -1247,6 +1254,7 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
1247
1254
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
1248
1255
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1249
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."),
|
|
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."),
|
|
1250
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."),
|
|
1251
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."),
|
|
1252
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."),
|
|
@@ -1273,6 +1281,7 @@ const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
|
1273
1281
|
developerName: true,
|
|
1274
1282
|
serverUrl: true,
|
|
1275
1283
|
tools: true,
|
|
1284
|
+
skills: true,
|
|
1276
1285
|
authentication: true
|
|
1277
1286
|
});
|
|
1278
1287
|
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
@@ -1447,10 +1456,53 @@ function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
|
1447
1456
|
return byField;
|
|
1448
1457
|
}
|
|
1449
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
|
+
});
|
|
1450
1501
|
const submissionMetaFieldsSchema = z.object({
|
|
1451
1502
|
id: z.string(),
|
|
1452
1503
|
environmentId: z.string(),
|
|
1453
1504
|
auditId: z.string().nullable(),
|
|
1505
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1454
1506
|
createdAt: z.coerce.date(),
|
|
1455
1507
|
updatedAt: z.coerce.date()
|
|
1456
1508
|
});
|
|
@@ -1464,8 +1516,10 @@ const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
|
1464
1516
|
formData: chatgptSubmissionDraftSchema,
|
|
1465
1517
|
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1466
1518
|
});
|
|
1467
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1519
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1468
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;
|
|
1469
1523
|
z.literal([
|
|
1470
1524
|
100,
|
|
1471
1525
|
75,
|
|
@@ -2312,6 +2366,45 @@ const getBeaconContractV1 = base.route({
|
|
|
2312
2366
|
createdAt: z.coerce.date(),
|
|
2313
2367
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
2314
2368
|
}));
|
|
2369
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2370
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2371
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2372
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2373
|
+
const createSubmissionContractV1 = base.route({
|
|
2374
|
+
path: "/v1/submissions",
|
|
2375
|
+
method: "POST",
|
|
2376
|
+
summary: "Create a submission package",
|
|
2377
|
+
description: "Create a submission package for an environment. Alpic reads the environment's live MCP server and prefills every field it can infer, so the response already carries the populated package. The environment must have a successful deployment and must not require authentication.",
|
|
2378
|
+
tags: ["submissions"],
|
|
2379
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2380
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2381
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2382
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2383
|
+
})).output(submissionSchema);
|
|
2384
|
+
const getSubmissionContractV1 = base.route({
|
|
2385
|
+
path: "/v1/submissions/{submissionId}",
|
|
2386
|
+
method: "GET",
|
|
2387
|
+
summary: "Get a submission package",
|
|
2388
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2389
|
+
tags: ["submissions"],
|
|
2390
|
+
successDescription: "The submission package"
|
|
2391
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2392
|
+
const updateSubmissionContractV1 = base.route({
|
|
2393
|
+
path: "/v1/submissions/{submissionId}",
|
|
2394
|
+
method: "PUT",
|
|
2395
|
+
summary: "Update a submission package",
|
|
2396
|
+
description: "Update the form data of a submission package. Only the fields you send are changed; the rest are left as they are. Unknown field names are rejected rather than ignored, so a typo fails the call. `platform` must match the package's own platform.",
|
|
2397
|
+
tags: ["submissions"],
|
|
2398
|
+
successDescription: "The updated submission package"
|
|
2399
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2400
|
+
submissionId: submissionIdSchema,
|
|
2401
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2402
|
+
formData: claudeSubmissionUpdateSchema
|
|
2403
|
+
}), z.object({
|
|
2404
|
+
submissionId: submissionIdSchema,
|
|
2405
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2406
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2407
|
+
})])).output(submissionSchema);
|
|
2315
2408
|
const contract = {
|
|
2316
2409
|
teams: {
|
|
2317
2410
|
list: { v1: listTeamsContractV1 },
|
|
@@ -2367,6 +2460,11 @@ const contract = {
|
|
|
2367
2460
|
beacon: {
|
|
2368
2461
|
create: { v1: createBeaconContractV1 },
|
|
2369
2462
|
get: { v1: getBeaconContractV1 }
|
|
2463
|
+
},
|
|
2464
|
+
submissions: {
|
|
2465
|
+
create: { v1: createSubmissionContractV1 },
|
|
2466
|
+
get: { v1: getSubmissionContractV1 },
|
|
2467
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2370
2468
|
}
|
|
2371
2469
|
};
|
|
2372
2470
|
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
@@ -2374,5 +2472,26 @@ const contractForDocs = {
|
|
|
2374
2472
|
...contract,
|
|
2375
2473
|
deployments: deploymentsForDocs
|
|
2376
2474
|
};
|
|
2475
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2476
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2477
|
+
info: {
|
|
2478
|
+
title: "Alpic API",
|
|
2479
|
+
version: "1.0.0"
|
|
2480
|
+
},
|
|
2481
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2482
|
+
security: [{ bearerAuth: [] }],
|
|
2483
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2484
|
+
type: "http",
|
|
2485
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2486
|
+
scheme: "bearer"
|
|
2487
|
+
} } },
|
|
2488
|
+
commonSchemas: {
|
|
2489
|
+
Submission: { schema: submissionSchema },
|
|
2490
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2491
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2492
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2493
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
2494
|
+
}
|
|
2495
|
+
};
|
|
2377
2496
|
//#endregion
|
|
2378
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2497
|
+
export { AI_PLATFORMS, AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, OPENAPI_DOC_OPTIONS, PLATFORM_LABELS, buildSettingsSchema, chatgptSubmissionUpdateSchema, claudeSubmissionUpdateSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@alpic-ai/api",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.172.0",
|
|
4
4
|
"description": "Contract for the Alpic API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.mjs",
|
|
@@ -44,9 +44,9 @@
|
|
|
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.0"
|
|
50
50
|
},
|
|
51
51
|
"scripts": {
|
|
52
52
|
"build": "shx rm -rf dist && tsdown",
|