@alpic-ai/api 0.0.0-dev.ge95779a → 0.0.0-dev.ge9cac3a

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.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.3/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
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
  */
@@ -864,6 +864,10 @@ const clampStringField = (field) => {
864
864
  const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
865
865
  return field.description ? withMin.describe(field.description) : withMin;
866
866
  };
867
+ const unboundedArrayField = (field) => {
868
+ const unbounded = z.array(field.element);
869
+ return field.description ? unbounded.describe(field.description) : unbounded;
870
+ };
867
871
  const toolDefinitionSchema = z.object({
868
872
  name: z.string(),
869
873
  title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
@@ -876,11 +880,19 @@ const toolDefinitionSchema = z.object({
876
880
  }).optional()
877
881
  });
878
882
  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."),
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."),
881
885
  toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
882
886
  expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
883
- }).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
887
+ }).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
888
+ const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial();
889
+ const blankPositiveTestCase = () => ({
890
+ scenario: "",
891
+ userPrompt: "",
892
+ toolTriggered: "",
893
+ expectedOutput: ""
894
+ });
895
+ const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
884
896
  const screenshotEntrySchema = z.object({
885
897
  prompt: z.string(),
886
898
  url: z.url()
@@ -1193,9 +1205,14 @@ const chatgptTranslationLocaleSchema = z.enum([
1193
1205
  "zh-TW"
1194
1206
  ]);
1195
1207
  const negativeTestCaseSchema = z.object({
1196
- scenario: z.string(),
1197
- userPrompt: z.string()
1198
- }).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
1208
+ scenario: z.string().min(1),
1209
+ userPrompt: z.string().min(1)
1210
+ }).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
1211
+ const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial();
1212
+ const blankNegativeTestCase = () => ({
1213
+ scenario: "",
1214
+ userPrompt: ""
1215
+ });
1199
1216
  const chatgptToolJustificationSchema = z.object({
1200
1217
  toolName: z.string(),
1201
1218
  readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
@@ -1230,8 +1247,8 @@ const chatgptSubmissionFormDataSchema = z.object({
1230
1247
  authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
1231
1248
  tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
1232
1249
  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
- testCases: z.array(positiveTestCaseSchema).describe("At least 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."),
1234
- negativeTestCases: z.array(negativeTestCaseSchema).describe("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."),
1250
+ 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
+ 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."),
1235
1252
  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."),
1236
1253
  translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
1237
1254
  allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
@@ -1246,23 +1263,34 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
1246
1263
  demoRecordingUrl: z.string().optional(),
1247
1264
  serverUrl: z.string().optional(),
1248
1265
  screenshots: z.array(screenshotDraftEntrySchema).optional(),
1266
+ testCases: z.array(positiveTestCaseDraftSchema).optional(),
1267
+ negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
1249
1268
  translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
1250
1269
  });
1251
- chatgptSubmissionFormDataSchema.pick({
1270
+ /** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
1271
+ const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
1252
1272
  appName: true,
1253
1273
  developerName: true,
1254
1274
  serverUrl: true,
1255
1275
  tools: true,
1256
1276
  authentication: true
1257
1277
  });
1258
- chatgptSubmissionFormDataSchema.pick({
1278
+ /** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
1279
+ const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
1259
1280
  tagline: true,
1260
1281
  description: true,
1261
1282
  category: true,
1262
1283
  testCases: true,
1263
1284
  negativeTestCases: true,
1264
1285
  toolJustifications: true
1265
- }).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
1286
+ }).extend({
1287
+ testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
1288
+ negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
1289
+ }).extend({
1290
+ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
1291
+ testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
1292
+ negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
1293
+ });
1266
1294
  const claudeCategorySchema = z.enum([
1267
1295
  "Productivity",
1268
1296
  "Communication",
@@ -1385,7 +1413,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
1385
1413
  categories: z.array(claudeCategorySchema).optional(),
1386
1414
  screenshots: z.array(screenshotDraftEntrySchema).optional()
1387
1415
  });
1388
- claudeSubmissionFormDataSchema.pick({
1416
+ /** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
1417
+ const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
1389
1418
  serverUrl: true,
1390
1419
  name: true,
1391
1420
  slug: true,
@@ -1407,27 +1436,81 @@ const claudeAiGeneratedFormDataRawSchema = z.object({
1407
1436
  categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
1408
1437
  primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
1409
1438
  });
1410
- claudeAiGeneratedFormDataRawSchema.extend({
1439
+ const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
1411
1440
  oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
1412
1441
  categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
1413
1442
  });
1443
+ function provenanceByField(prefillShape, aiGeneratedShape) {
1444
+ const byField = {};
1445
+ for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
1446
+ for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
1447
+ return byField;
1448
+ }
1449
+ provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
1450
+ const urlVerificationOutcomeSchema = z.enum([
1451
+ "pass",
1452
+ "fail",
1453
+ "unverified"
1454
+ ]);
1455
+ const VERIFIABLE_URL_FIELDS = {
1456
+ chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
1457
+ claudeai: ["privacyPolicy"]
1458
+ };
1459
+ const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
1460
+ const policyDisclosureSchema = z.enum([
1461
+ "dataCategories",
1462
+ "purposesOfUse",
1463
+ "recipients",
1464
+ "retention"
1465
+ ]);
1466
+ const urlVerificationFieldResultSchema = z.object({
1467
+ field: verifiableUrlFieldSchema,
1468
+ url: z.string(),
1469
+ outcome: urlVerificationOutcomeSchema,
1470
+ reason: z.string(),
1471
+ concerns: z.array(z.string()).optional(),
1472
+ scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
1473
+ });
1474
+ const urlVerificationSchema = z.object({
1475
+ verifiedAt: z.coerce.date(),
1476
+ results: z.array(urlVerificationFieldResultSchema)
1477
+ });
1478
+ const pageKindSchema = z.enum([
1479
+ "expectedDocument",
1480
+ "errorPage",
1481
+ "loginWall",
1482
+ "parkedDomain",
1483
+ "comingSoon",
1484
+ "marketingPage",
1485
+ "unrelatedDocument"
1486
+ ]);
1487
+ z.object({
1488
+ pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
1489
+ reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
1490
+ 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.")
1491
+ });
1414
1492
  const submissionMetaFieldsSchema = z.object({
1415
1493
  id: z.string(),
1416
1494
  environmentId: z.string(),
1417
1495
  auditId: z.string().nullable(),
1496
+ urlVerification: urlVerificationSchema.nullable().default(null),
1418
1497
  createdAt: z.coerce.date(),
1419
1498
  updatedAt: z.coerce.date()
1420
1499
  });
1421
1500
  const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
1422
1501
  platform: z.literal("claudeai"),
1423
- formData: claudeSubmissionDraftSchema
1502
+ formData: claudeSubmissionDraftSchema,
1503
+ prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
1424
1504
  });
1425
1505
  const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
1426
1506
  platform: z.literal("chatgpt"),
1427
- formData: chatgptSubmissionDraftSchema
1507
+ formData: chatgptSubmissionDraftSchema,
1508
+ prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
1428
1509
  });
1429
- z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
1510
+ const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
1430
1511
  z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
1512
+ /** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
1513
+ const submissionSchema = submissionSchemaInternal;
1431
1514
  z.literal([
1432
1515
  100,
1433
1516
  75,
@@ -1684,6 +1767,14 @@ const getEnvironmentContractV1 = base.route({
1684
1767
  createdAt: z.coerce.date(),
1685
1768
  projectId: z.string()
1686
1769
  }));
1770
+ const deleteEnvironmentContractV1 = base.route({
1771
+ path: "/v1/environments/{environmentId}",
1772
+ method: "DELETE",
1773
+ summary: "Delete an environment",
1774
+ description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
1775
+ tags: ["environments"],
1776
+ successDescription: "The environment has been deleted successfully"
1777
+ }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
1687
1778
  const domainSchema = z.object({
1688
1779
  domain: z.string(),
1689
1780
  status: z.enum([
@@ -2266,6 +2357,45 @@ const getBeaconContractV1 = base.route({
2266
2357
  createdAt: z.coerce.date(),
2267
2358
  report: auditReportWithScreenshotsSchema.nullable()
2268
2359
  }));
2360
+ const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
2361
+ const submissionIdSchema = z.string().describe("The ID of the submission package");
2362
+ const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
2363
+ const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
2364
+ const createSubmissionContractV1 = base.route({
2365
+ path: "/v1/submissions",
2366
+ method: "POST",
2367
+ summary: "Create a submission package",
2368
+ 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.",
2369
+ tags: ["submissions"],
2370
+ successDescription: "The created submission package, with its prefilled fields"
2371
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2372
+ environmentId: z.string().describe("The ID of the environment to build the package from"),
2373
+ platform: platformSchema.describe(PLATFORM_DESCRIPTION)
2374
+ })).output(submissionSchema);
2375
+ const getSubmissionContractV1 = base.route({
2376
+ path: "/v1/submissions/{submissionId}",
2377
+ method: "GET",
2378
+ summary: "Get a submission package",
2379
+ description: "Get a submission package by ID, including its form data and the prefill it started from",
2380
+ tags: ["submissions"],
2381
+ successDescription: "The submission package"
2382
+ }).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
2383
+ const updateSubmissionContractV1 = base.route({
2384
+ path: "/v1/submissions/{submissionId}",
2385
+ method: "PUT",
2386
+ summary: "Update a submission package",
2387
+ 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.",
2388
+ tags: ["submissions"],
2389
+ successDescription: "The updated submission package"
2390
+ }).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
2391
+ submissionId: submissionIdSchema,
2392
+ platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
2393
+ formData: claudeSubmissionUpdateSchema
2394
+ }), z.object({
2395
+ submissionId: submissionIdSchema,
2396
+ platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
2397
+ formData: chatgptSubmissionUpdateSchema
2398
+ })])).output(submissionSchema);
2269
2399
  const contract = {
2270
2400
  teams: {
2271
2401
  list: { v1: listTeamsContractV1 },
@@ -2291,6 +2421,7 @@ const contract = {
2291
2421
  environments: {
2292
2422
  create: { v1: createEnvironmentContractV1 },
2293
2423
  get: { v1: getEnvironmentContractV1 },
2424
+ delete: { v1: deleteEnvironmentContractV1 },
2294
2425
  deploy: { v1: deployEnvironmentContractV1 },
2295
2426
  getLogs: { v1: getLogsContractV1 },
2296
2427
  getLatestLogs: { v1: getLatestLogsContractV1 }
@@ -2320,6 +2451,11 @@ const contract = {
2320
2451
  beacon: {
2321
2452
  create: { v1: createBeaconContractV1 },
2322
2453
  get: { v1: getBeaconContractV1 }
2454
+ },
2455
+ submissions: {
2456
+ create: { v1: createSubmissionContractV1 },
2457
+ get: { v1: getSubmissionContractV1 },
2458
+ update: { v1: updateSubmissionContractV1 }
2323
2459
  }
2324
2460
  };
2325
2461
  const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
@@ -2327,5 +2463,26 @@ const contractForDocs = {
2327
2463
  ...contract,
2328
2464
  deployments: deploymentsForDocs
2329
2465
  };
2466
+ /** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
2467
+ const OPENAPI_DOC_OPTIONS = {
2468
+ info: {
2469
+ title: "Alpic API",
2470
+ version: "1.0.0"
2471
+ },
2472
+ servers: [{ url: "https://api.alpic.ai" }],
2473
+ security: [{ bearerAuth: [] }],
2474
+ components: { securitySchemes: { bearerAuth: {
2475
+ type: "http",
2476
+ description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
2477
+ scheme: "bearer"
2478
+ } } },
2479
+ commonSchemas: {
2480
+ Submission: { schema: submissionSchema },
2481
+ ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
2482
+ ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
2483
+ ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
2484
+ ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
2485
+ }
2486
+ };
2330
2487
  //#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 };
2488
+ 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.ge95779a",
3
+ "version": "0.0.0-dev.ge9cac3a",
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.3"
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.22.14",
47
+ "tsdown": "^0.23.0",
47
48
  "typescript": "^6.0.3",
48
- "vitest": "^4.1.10",
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",