@alpic-ai/api 0.0.0-dev.gd7a6f1d → 0.0.0-dev.gd7abf73
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 +4757 -53
- package/dist/index.mjs +145 -5
- package/package.json +6 -6
package/dist/index.mjs
CHANGED
|
@@ -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(),
|
|
@@ -864,6 +865,10 @@ const clampStringField = (field) => {
|
|
|
864
865
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
865
866
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
866
867
|
};
|
|
868
|
+
const unboundedArrayField = (field) => {
|
|
869
|
+
const unbounded = z.array(field.element);
|
|
870
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
871
|
+
};
|
|
867
872
|
const toolDefinitionSchema = z.object({
|
|
868
873
|
name: z.string(),
|
|
869
874
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -881,7 +886,10 @@ const positiveTestCaseSchema = z.object({
|
|
|
881
886
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
882
887
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
883
888
|
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
884
|
-
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial()
|
|
889
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
890
|
+
scenario: z.string().optional(),
|
|
891
|
+
userPrompt: z.string().optional()
|
|
892
|
+
});
|
|
885
893
|
const blankPositiveTestCase = () => ({
|
|
886
894
|
scenario: "",
|
|
887
895
|
userPrompt: "",
|
|
@@ -1204,11 +1212,15 @@ const negativeTestCaseSchema = z.object({
|
|
|
1204
1212
|
scenario: z.string().min(1),
|
|
1205
1213
|
userPrompt: z.string().min(1)
|
|
1206
1214
|
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1207
|
-
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial()
|
|
1215
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1216
|
+
scenario: z.string().optional(),
|
|
1217
|
+
userPrompt: z.string().optional()
|
|
1218
|
+
});
|
|
1208
1219
|
const blankNegativeTestCase = () => ({
|
|
1209
1220
|
scenario: "",
|
|
1210
1221
|
userPrompt: ""
|
|
1211
1222
|
});
|
|
1223
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
1212
1224
|
const chatgptToolJustificationSchema = z.object({
|
|
1213
1225
|
toolName: z.string(),
|
|
1214
1226
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
@@ -1243,6 +1255,7 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
1243
1255
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
1244
1256
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1245
1257
|
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."),
|
|
1258
|
+
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."),
|
|
1246
1259
|
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."),
|
|
1247
1260
|
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."),
|
|
1248
1261
|
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."),
|
|
@@ -1269,6 +1282,7 @@ const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
|
1269
1282
|
developerName: true,
|
|
1270
1283
|
serverUrl: true,
|
|
1271
1284
|
tools: true,
|
|
1285
|
+
skills: true,
|
|
1272
1286
|
authentication: true
|
|
1273
1287
|
});
|
|
1274
1288
|
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
@@ -1279,6 +1293,9 @@ const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
|
1279
1293
|
testCases: true,
|
|
1280
1294
|
negativeTestCases: true,
|
|
1281
1295
|
toolJustifications: true
|
|
1296
|
+
}).extend({
|
|
1297
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1298
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1282
1299
|
}).extend({
|
|
1283
1300
|
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1284
1301
|
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
@@ -1440,10 +1457,53 @@ function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
|
1440
1457
|
return byField;
|
|
1441
1458
|
}
|
|
1442
1459
|
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1460
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1461
|
+
"pass",
|
|
1462
|
+
"fail",
|
|
1463
|
+
"unverified"
|
|
1464
|
+
]);
|
|
1465
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1466
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1467
|
+
claudeai: ["privacyPolicy"]
|
|
1468
|
+
};
|
|
1469
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1470
|
+
const policyDisclosureSchema = z.enum([
|
|
1471
|
+
"dataCategories",
|
|
1472
|
+
"purposesOfUse",
|
|
1473
|
+
"recipients",
|
|
1474
|
+
"retention"
|
|
1475
|
+
]);
|
|
1476
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1477
|
+
field: verifiableUrlFieldSchema,
|
|
1478
|
+
url: z.string(),
|
|
1479
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1480
|
+
reason: z.string(),
|
|
1481
|
+
concerns: z.array(z.string()).optional(),
|
|
1482
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1483
|
+
});
|
|
1484
|
+
const urlVerificationSchema = z.object({
|
|
1485
|
+
verifiedAt: z.coerce.date(),
|
|
1486
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1487
|
+
});
|
|
1488
|
+
const pageKindSchema = z.enum([
|
|
1489
|
+
"expectedDocument",
|
|
1490
|
+
"errorPage",
|
|
1491
|
+
"loginWall",
|
|
1492
|
+
"parkedDomain",
|
|
1493
|
+
"comingSoon",
|
|
1494
|
+
"marketingPage",
|
|
1495
|
+
"unrelatedDocument"
|
|
1496
|
+
]);
|
|
1497
|
+
z.object({
|
|
1498
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1499
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1500
|
+
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.")
|
|
1501
|
+
});
|
|
1443
1502
|
const submissionMetaFieldsSchema = z.object({
|
|
1444
1503
|
id: z.string(),
|
|
1445
1504
|
environmentId: z.string(),
|
|
1446
1505
|
auditId: z.string().nullable(),
|
|
1506
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1447
1507
|
createdAt: z.coerce.date(),
|
|
1448
1508
|
updatedAt: z.coerce.date()
|
|
1449
1509
|
});
|
|
@@ -1457,8 +1517,10 @@ const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
|
1457
1517
|
formData: chatgptSubmissionDraftSchema,
|
|
1458
1518
|
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1459
1519
|
});
|
|
1460
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1520
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1461
1521
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1522
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1523
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1462
1524
|
z.literal([
|
|
1463
1525
|
100,
|
|
1464
1526
|
75,
|
|
@@ -2305,6 +2367,57 @@ const getBeaconContractV1 = base.route({
|
|
|
2305
2367
|
createdAt: z.coerce.date(),
|
|
2306
2368
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
2307
2369
|
}));
|
|
2370
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2371
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2372
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2373
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2374
|
+
const createSubmissionContractV1 = base.route({
|
|
2375
|
+
path: "/v1/submissions",
|
|
2376
|
+
method: "POST",
|
|
2377
|
+
summary: "Create a submission package",
|
|
2378
|
+
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.",
|
|
2379
|
+
tags: ["submissions"],
|
|
2380
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2381
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2382
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2383
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2384
|
+
})).output(submissionSchema);
|
|
2385
|
+
const listSubmissionsContractV1 = base.route({
|
|
2386
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2387
|
+
method: "GET",
|
|
2388
|
+
summary: "List submission packages",
|
|
2389
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2390
|
+
tags: ["submissions"],
|
|
2391
|
+
successDescription: "The list of submission packages"
|
|
2392
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2393
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2394
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2395
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2396
|
+
})).output(z.array(submissionSchema));
|
|
2397
|
+
const getSubmissionContractV1 = base.route({
|
|
2398
|
+
path: "/v1/submissions/{submissionId}",
|
|
2399
|
+
method: "GET",
|
|
2400
|
+
summary: "Get a submission package",
|
|
2401
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2402
|
+
tags: ["submissions"],
|
|
2403
|
+
successDescription: "The submission package"
|
|
2404
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2405
|
+
const updateSubmissionContractV1 = base.route({
|
|
2406
|
+
path: "/v1/submissions/{submissionId}",
|
|
2407
|
+
method: "PUT",
|
|
2408
|
+
summary: "Update a submission package",
|
|
2409
|
+
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.",
|
|
2410
|
+
tags: ["submissions"],
|
|
2411
|
+
successDescription: "The updated submission package"
|
|
2412
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2413
|
+
submissionId: submissionIdSchema,
|
|
2414
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2415
|
+
formData: claudeSubmissionUpdateSchema
|
|
2416
|
+
}), z.object({
|
|
2417
|
+
submissionId: submissionIdSchema,
|
|
2418
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2419
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2420
|
+
})])).output(submissionSchema);
|
|
2308
2421
|
const contract = {
|
|
2309
2422
|
teams: {
|
|
2310
2423
|
list: { v1: listTeamsContractV1 },
|
|
@@ -2360,6 +2473,12 @@ const contract = {
|
|
|
2360
2473
|
beacon: {
|
|
2361
2474
|
create: { v1: createBeaconContractV1 },
|
|
2362
2475
|
get: { v1: getBeaconContractV1 }
|
|
2476
|
+
},
|
|
2477
|
+
submissions: {
|
|
2478
|
+
create: { v1: createSubmissionContractV1 },
|
|
2479
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2480
|
+
get: { v1: getSubmissionContractV1 },
|
|
2481
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2363
2482
|
}
|
|
2364
2483
|
};
|
|
2365
2484
|
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
@@ -2367,5 +2486,26 @@ const contractForDocs = {
|
|
|
2367
2486
|
...contract,
|
|
2368
2487
|
deployments: deploymentsForDocs
|
|
2369
2488
|
};
|
|
2489
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2490
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2491
|
+
info: {
|
|
2492
|
+
title: "Alpic API",
|
|
2493
|
+
version: "1.0.0"
|
|
2494
|
+
},
|
|
2495
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2496
|
+
security: [{ bearerAuth: [] }],
|
|
2497
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2498
|
+
type: "http",
|
|
2499
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2500
|
+
scheme: "bearer"
|
|
2501
|
+
} } },
|
|
2502
|
+
commonSchemas: {
|
|
2503
|
+
Submission: { schema: submissionSchema },
|
|
2504
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2505
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2506
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2507
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
2508
|
+
}
|
|
2509
|
+
};
|
|
2370
2510
|
//#endregion
|
|
2371
|
-
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 };
|
|
2511
|
+
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.gd7abf73",
|
|
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
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.2",
|
|
43
|
+
"@orpc/zod": "^1.15.2",
|
|
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.1"
|
|
50
50
|
},
|
|
51
51
|
"scripts": {
|
|
52
52
|
"build": "shx rm -rf dist && tsdown",
|