@alpic-ai/api 1.170.0 → 1.171.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 +22 -0
- package/dist/index.mjs +63 -16
- package/package.json +4 -4
package/dist/index.d.mts
CHANGED
|
@@ -470,6 +470,17 @@ declare const contract: {
|
|
|
470
470
|
NOT_FOUND: {};
|
|
471
471
|
}>, Record<never, never>>;
|
|
472
472
|
};
|
|
473
|
+
delete: {
|
|
474
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
475
|
+
environmentId: z.ZodString;
|
|
476
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
477
|
+
success: z.ZodLiteral<true>;
|
|
478
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
479
|
+
BAD_REQUEST: {};
|
|
480
|
+
}>, {
|
|
481
|
+
NOT_FOUND: {};
|
|
482
|
+
}>, Record<never, never>>;
|
|
483
|
+
};
|
|
473
484
|
deploy: {
|
|
474
485
|
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
475
486
|
environmentId: z.ZodString;
|
|
@@ -1645,6 +1656,17 @@ declare const contractForDocs: {
|
|
|
1645
1656
|
NOT_FOUND: {};
|
|
1646
1657
|
}>, Record<never, never>>;
|
|
1647
1658
|
};
|
|
1659
|
+
delete: {
|
|
1660
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
1661
|
+
environmentId: z.ZodString;
|
|
1662
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1663
|
+
success: z.ZodLiteral<true>;
|
|
1664
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
1665
|
+
BAD_REQUEST: {};
|
|
1666
|
+
}>, {
|
|
1667
|
+
NOT_FOUND: {};
|
|
1668
|
+
}>, Record<never, never>>;
|
|
1669
|
+
};
|
|
1648
1670
|
deploy: {
|
|
1649
1671
|
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
1650
1672
|
environmentId: z.ZodString;
|
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
|
*/
|
|
@@ -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
|
-
}).
|
|
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
|
-
}).
|
|
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("
|
|
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
|
-
|
|
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
|
-
|
|
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({
|
|
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
|
-
|
|
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,10 +1436,17 @@ 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);
|
|
1414
1450
|
const submissionMetaFieldsSchema = z.object({
|
|
1415
1451
|
id: z.string(),
|
|
1416
1452
|
environmentId: z.string(),
|
|
@@ -1420,11 +1456,13 @@ const submissionMetaFieldsSchema = z.object({
|
|
|
1420
1456
|
});
|
|
1421
1457
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1422
1458
|
platform: z.literal("claudeai"),
|
|
1423
|
-
formData: claudeSubmissionDraftSchema
|
|
1459
|
+
formData: claudeSubmissionDraftSchema,
|
|
1460
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1424
1461
|
});
|
|
1425
1462
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1426
1463
|
platform: z.literal("chatgpt"),
|
|
1427
|
-
formData: chatgptSubmissionDraftSchema
|
|
1464
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1465
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1428
1466
|
});
|
|
1429
1467
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1430
1468
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
@@ -1684,6 +1722,14 @@ const getEnvironmentContractV1 = base.route({
|
|
|
1684
1722
|
createdAt: z.coerce.date(),
|
|
1685
1723
|
projectId: z.string()
|
|
1686
1724
|
}));
|
|
1725
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1726
|
+
path: "/v1/environments/{environmentId}",
|
|
1727
|
+
method: "DELETE",
|
|
1728
|
+
summary: "Delete an environment",
|
|
1729
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1730
|
+
tags: ["environments"],
|
|
1731
|
+
successDescription: "The environment has been deleted successfully"
|
|
1732
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1687
1733
|
const domainSchema = z.object({
|
|
1688
1734
|
domain: z.string(),
|
|
1689
1735
|
status: z.enum([
|
|
@@ -2291,6 +2337,7 @@ const contract = {
|
|
|
2291
2337
|
environments: {
|
|
2292
2338
|
create: { v1: createEnvironmentContractV1 },
|
|
2293
2339
|
get: { v1: getEnvironmentContractV1 },
|
|
2340
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
2294
2341
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
2295
2342
|
getLogs: { v1: getLogsContractV1 },
|
|
2296
2343
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@alpic-ai/api",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.171.0",
|
|
4
4
|
"description": "Contract for the Alpic API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.mjs",
|
|
@@ -35,9 +35,10 @@
|
|
|
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",
|
|
@@ -45,8 +46,7 @@
|
|
|
45
46
|
"shx": "^0.4.0",
|
|
46
47
|
"tsdown": "^0.22.14",
|
|
47
48
|
"typescript": "^6.0.3",
|
|
48
|
-
"vitest": "^4.1.
|
|
49
|
-
"@alpic-ai/domains": "0.0.0"
|
|
49
|
+
"vitest": "^4.1.11"
|
|
50
50
|
},
|
|
51
51
|
"scripts": {
|
|
52
52
|
"build": "shx rm -rf dist && tsdown",
|