@alpic-ai/api 0.0.0-staging.7ef3a46 → 0.0.0-staging.7f06d79
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 +195 -214
- package/dist/index.mjs +405 -81
- package/package.json +18 -6
package/dist/index.mjs
CHANGED
|
@@ -1,6 +1,296 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
1
2
|
import { oc } from "@orpc/contract";
|
|
2
3
|
import ms from "ms";
|
|
3
|
-
|
|
4
|
+
const platformSchema = z.enum(["chatgpt", "claudeai"]);
|
|
5
|
+
const PLATFORM_LABELS = {
|
|
6
|
+
chatgpt: "ChatGPT",
|
|
7
|
+
claudeai: "Claude.ai"
|
|
8
|
+
};
|
|
9
|
+
const auditStatusSchema = z.enum([
|
|
10
|
+
"pending",
|
|
11
|
+
"partial",
|
|
12
|
+
"completed",
|
|
13
|
+
"failed"
|
|
14
|
+
]);
|
|
15
|
+
const checkSeveritySchema = z.enum([
|
|
16
|
+
"error",
|
|
17
|
+
"warning",
|
|
18
|
+
"info"
|
|
19
|
+
]);
|
|
20
|
+
const checkCategorySchema = z.enum([
|
|
21
|
+
"connectivity",
|
|
22
|
+
"tool-metadata",
|
|
23
|
+
"resource-metadata",
|
|
24
|
+
"performance",
|
|
25
|
+
"e2e"
|
|
26
|
+
]);
|
|
27
|
+
const checkScopeSchema = z.enum(["server", "view"]);
|
|
28
|
+
const checkDetailSchema = z.object({
|
|
29
|
+
label: z.string(),
|
|
30
|
+
value: z.string().optional()
|
|
31
|
+
});
|
|
32
|
+
const checkResultSchema = z.object({
|
|
33
|
+
checkId: z.string(),
|
|
34
|
+
checkName: z.string(),
|
|
35
|
+
description: z.string(),
|
|
36
|
+
status: z.enum([
|
|
37
|
+
"pass",
|
|
38
|
+
"fail",
|
|
39
|
+
"skip",
|
|
40
|
+
"pending"
|
|
41
|
+
]),
|
|
42
|
+
message: z.string(),
|
|
43
|
+
skipReason: z.string().optional(),
|
|
44
|
+
severity: checkSeveritySchema,
|
|
45
|
+
category: checkCategorySchema,
|
|
46
|
+
scope: checkScopeSchema,
|
|
47
|
+
platforms: z.array(platformSchema).readonly().optional(),
|
|
48
|
+
durationMs: z.number(),
|
|
49
|
+
details: z.array(checkDetailSchema).optional(),
|
|
50
|
+
hint: z.object({ text: z.string() }).optional()
|
|
51
|
+
});
|
|
52
|
+
const auditReportSchema = z.object({
|
|
53
|
+
schemaVersion: z.string(),
|
|
54
|
+
auditId: z.string(),
|
|
55
|
+
targetUrl: z.string(),
|
|
56
|
+
startedAt: z.string(),
|
|
57
|
+
completedAt: z.string(),
|
|
58
|
+
durationMs: z.number(),
|
|
59
|
+
results: z.array(checkResultSchema),
|
|
60
|
+
requiresAuth: z.boolean(),
|
|
61
|
+
hasViewSupport: z.boolean(),
|
|
62
|
+
viewPlatforms: z.array(platformSchema).readonly().optional(),
|
|
63
|
+
isReadyForPlatform: z.record(platformSchema, z.boolean()),
|
|
64
|
+
widgetScreenshotKeys: z.object({
|
|
65
|
+
chatgpt: z.string().optional(),
|
|
66
|
+
claudeai: z.string().optional()
|
|
67
|
+
})
|
|
68
|
+
});
|
|
69
|
+
const widgetScreenshotSchema = z.object({ url: z.string() });
|
|
70
|
+
const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreenshots: z.object({
|
|
71
|
+
chatgpt: widgetScreenshotSchema.optional(),
|
|
72
|
+
claudeai: widgetScreenshotSchema.optional()
|
|
73
|
+
}) });
|
|
74
|
+
z.object({
|
|
75
|
+
id: z.string(),
|
|
76
|
+
createdAt: z.coerce.date(),
|
|
77
|
+
environmentId: z.string(),
|
|
78
|
+
content: z.string(),
|
|
79
|
+
source: z.enum(["model", "user"])
|
|
80
|
+
});
|
|
81
|
+
z.object({
|
|
82
|
+
content: z.string(),
|
|
83
|
+
source: z.enum(["model", "user"])
|
|
84
|
+
});
|
|
85
|
+
const toolDefinitionSchema = z.object({
|
|
86
|
+
name: z.string(),
|
|
87
|
+
title: z.string().optional(),
|
|
88
|
+
description: z.string().optional(),
|
|
89
|
+
annotations: z.object({
|
|
90
|
+
readOnlyHint: z.boolean().optional(),
|
|
91
|
+
destructiveHint: z.boolean().optional(),
|
|
92
|
+
openWorldHint: z.boolean().optional(),
|
|
93
|
+
idempotentHint: z.boolean().optional()
|
|
94
|
+
}).optional()
|
|
95
|
+
});
|
|
96
|
+
const positiveTestCaseSchema = z.object({
|
|
97
|
+
scenario: z.string(),
|
|
98
|
+
userPrompt: z.string(),
|
|
99
|
+
toolTriggered: z.string().optional(),
|
|
100
|
+
expectedOutput: z.string().optional()
|
|
101
|
+
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
102
|
+
/** Accepts either a valid email or URL. */
|
|
103
|
+
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
104
|
+
const chatgptCategorySchema = z.enum([
|
|
105
|
+
"BUSINESS",
|
|
106
|
+
"COLLABORATION",
|
|
107
|
+
"DESIGN",
|
|
108
|
+
"DEVELOPER_TOOLS",
|
|
109
|
+
"EDUCATION",
|
|
110
|
+
"ENTERTAINMENT",
|
|
111
|
+
"FINANCE",
|
|
112
|
+
"FOOD",
|
|
113
|
+
"LIFESTYLE",
|
|
114
|
+
"NEWS",
|
|
115
|
+
"PRODUCTIVITY",
|
|
116
|
+
"SHOPPING",
|
|
117
|
+
"TRAVEL"
|
|
118
|
+
]);
|
|
119
|
+
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
120
|
+
const chatgptAllowedCountriesSchema = z.enum(["Allow all", "Restrict to specific countries"]);
|
|
121
|
+
const negativeTestCaseSchema = z.object({
|
|
122
|
+
scenario: z.string(),
|
|
123
|
+
userPrompt: z.string()
|
|
124
|
+
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
125
|
+
const chatgptToolJustificationSchema = z.object({
|
|
126
|
+
toolName: z.string(),
|
|
127
|
+
readOnlyJustification: z.string(),
|
|
128
|
+
openWorldJustification: z.string(),
|
|
129
|
+
destructiveJustification: z.string()
|
|
130
|
+
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
131
|
+
const chatgptTranslationSchema = z.object({
|
|
132
|
+
locale: z.string(),
|
|
133
|
+
tagline: z.string().optional(),
|
|
134
|
+
description: z.string().optional()
|
|
135
|
+
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
136
|
+
/**
|
|
137
|
+
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
138
|
+
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
139
|
+
*/
|
|
140
|
+
const chatgptSubmissionFormDataSchema = z.object({
|
|
141
|
+
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
142
|
+
logoDark: z.string().describe("Logo icon for dark mode. Square PNG. Same specs as the light icon."),
|
|
143
|
+
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
144
|
+
tagline: z.string().max(30).describe("Plain-language phrase focused on function and user value. 30 chars max."),
|
|
145
|
+
description: z.string().describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
|
|
146
|
+
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
147
|
+
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
148
|
+
companyUrl: z.url().describe("Your company's main website URL."),
|
|
149
|
+
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
150
|
+
privacyPolicyUrl: z.url().describe("URL to your privacy policy."),
|
|
151
|
+
termsOfServiceUrl: z.url().describe("URL to the app's terms of service."),
|
|
152
|
+
demoRecordingUrl: z.url().describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
153
|
+
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My app links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the app does not offer digital goods."),
|
|
154
|
+
serverUrl: z.url().describe("URL of the MCP server."),
|
|
155
|
+
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
156
|
+
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
157
|
+
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
158
|
+
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Coverage over all major use cases."),
|
|
159
|
+
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases — prompts where the app should NOT trigger but the model might think it's relevant."),
|
|
160
|
+
screenshots: z.array(z.url()).describe("URLs of in-app screenshots. Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 4. First three are public."),
|
|
161
|
+
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
162
|
+
allowedCountries: chatgptAllowedCountriesSchema.describe("'Allow all' or restrict to a specific list. See OpenAI's supported countries list."),
|
|
163
|
+
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
164
|
+
});
|
|
165
|
+
chatgptSubmissionFormDataSchema.pick({
|
|
166
|
+
appName: true,
|
|
167
|
+
developerName: true,
|
|
168
|
+
serverUrl: true,
|
|
169
|
+
tools: true,
|
|
170
|
+
authentication: true
|
|
171
|
+
}).partial();
|
|
172
|
+
const claudeCategorySchema = z.enum([
|
|
173
|
+
"Business & Productivity",
|
|
174
|
+
"Communication",
|
|
175
|
+
"Data & Analytics",
|
|
176
|
+
"Development tools",
|
|
177
|
+
"Financial Services",
|
|
178
|
+
"Consumer Health",
|
|
179
|
+
"Health & Life Sciences",
|
|
180
|
+
"Media & Entertainment",
|
|
181
|
+
"Commerce & Shopping"
|
|
182
|
+
]);
|
|
183
|
+
z.enum([
|
|
184
|
+
"No auth needed",
|
|
185
|
+
"OAuth 2.0",
|
|
186
|
+
"Custom URL"
|
|
187
|
+
]);
|
|
188
|
+
const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
|
|
189
|
+
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
190
|
+
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
191
|
+
"Read only",
|
|
192
|
+
"Write only",
|
|
193
|
+
"Read + write"
|
|
194
|
+
]);
|
|
195
|
+
const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
|
|
196
|
+
const claudeThirdPartySchema = z.enum([
|
|
197
|
+
"Web access (open web fetch / scraping / arbitrary URLs)",
|
|
198
|
+
"Third-party AI model integration",
|
|
199
|
+
"Third-party data retrieval (via workflow / aggregator)",
|
|
200
|
+
"Third-party data modification (via workflow / aggregator)",
|
|
201
|
+
"N/A"
|
|
202
|
+
]);
|
|
203
|
+
const claudeDataHandlingSchema = z.enum([
|
|
204
|
+
"Server only accesses data explicitly requested by user",
|
|
205
|
+
"No data is stored beyond session requirements",
|
|
206
|
+
"Data transmission is encrypted (HTTPS / TLS)",
|
|
207
|
+
"GDPR compliant (if applicable)"
|
|
208
|
+
]);
|
|
209
|
+
const claudeSponsoredContentSchema = z.enum([
|
|
210
|
+
"No, there is no sponsored content or advertisements",
|
|
211
|
+
"Yes, there are banner ads or other paid visual elements",
|
|
212
|
+
"Yes, returned content or ranking is impacted by sponsorship or ad placement"
|
|
213
|
+
]);
|
|
214
|
+
/**
|
|
215
|
+
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
216
|
+
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
217
|
+
*/
|
|
218
|
+
const claudeSubmissionFormDataSchema = z.object({
|
|
219
|
+
companyName: z.string().describe("Enter your company's legal name or the name under which your product is publicly known. This is used for internal tracking and may appear in directory listings."),
|
|
220
|
+
companyUrl: z.url().describe("Your company's main website URL, e.g. https://mycompany.com. Must be a valid URL with https://. This should be the root domain of the company behind this MCP server."),
|
|
221
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. This person will receive review feedback, approval notices, and any follow-up questions."),
|
|
222
|
+
primaryContactEmail: z.email().describe("Business email for the primary contact. Must be a valid email address. Anthropic uses this to communicate about your submission status, required changes, and post-listing issues. Avoid using personal email addresses."),
|
|
223
|
+
primaryContactRole: z.string().optional().describe("The job title or role of the primary contact (e.g. 'CTO', 'Developer Relations Lead', 'Founder'). Optional but helps Anthropic route questions to the right person."),
|
|
224
|
+
anthropicPointOfContact: z.string().optional().describe("If you have a direct contact at Anthropic (e.g. from a partnership or sales conversation), enter their name here. This is optional but can greatly help expedite the review process. Leave blank if you don't have one."),
|
|
225
|
+
appName: z.string().describe(`The public display name for your connector as it will appear in the Connectors Directory.
|
|
226
|
+
|
|
227
|
+
Rules:
|
|
228
|
+
(1) Do NOT include the words 'MCP' or 'Server' — these are auto-rejected.
|
|
229
|
+
(2) Use your brand/product name, e.g. 'Notion', 'Linear', 'Slack'.
|
|
230
|
+
(3) You must own or have the right to use this brand name. For example, don't call it 'Google Drive Helper' if you're not Google.`),
|
|
231
|
+
mcpUrlType: claudeMcpUrlTypeSchema.describe("Universal URL = one URL serves all users. Custom MCP URLs = signup URL + regex matching per-user URLs."),
|
|
232
|
+
serverUrl: z.url().describe("Production MCP server URL (https). Derived from the project's production environment by default."),
|
|
233
|
+
tagline: z.string().max(55).describe("Short blurb shown below the server name. 55 chars max."),
|
|
234
|
+
description: z.string().describe("50–100 words describing what the server does and its key capabilities. Lives on the directory listing."),
|
|
235
|
+
testCases: z.array(positiveTestCaseSchema).describe("At least 3 use cases with example prompts showing the value of the connector."),
|
|
236
|
+
connectionRequirements: z.string().describe(`Prerequisites before connecting:
|
|
237
|
+
• Free/premium account
|
|
238
|
+
• Admin seat
|
|
239
|
+
• Geographic availability
|
|
240
|
+
• Custom instance URL
|
|
241
|
+
|
|
242
|
+
State 'No special requirements.' if none.`),
|
|
243
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe("Inferred from the `readOnlyHint` annotations on the MCP tools."),
|
|
244
|
+
isMcpApp: z.boolean().describe("True if the server exposes interactive UI elements (widgets). Inferred from the MCP connection."),
|
|
245
|
+
thirdPartyConnectionsAndWebAccess: z.array(claudeThirdPartySchema).describe("Multi-select of what the server reaches out to (web, third-party AI, data aggregators)."),
|
|
246
|
+
dataHandling: z.array(claudeDataHandlingSchema).describe("Multi-select of data-handling practices that accurately describe the server. Cannot be inferred — user must self-declare."),
|
|
247
|
+
personalDataHealthAccess: z.boolean().describe("True only if the connector gives users access to their own personal health data (medical records, lab results, health metrics)."),
|
|
248
|
+
categories: z.array(claudeCategorySchema).describe("Multi-select of categories that best describe the server in the directory."),
|
|
249
|
+
sponsoredContentsOrAdvertisement: claudeSponsoredContentSchema.describe("Disclose paid promotion or sponsored content. Cannot be filled by Alpic — user must self-declare."),
|
|
250
|
+
transportSupport: z.array(claudeTransportSchema).describe("Multi-select of transport protocols the server supports. Anthropic recommends Streamable HTTP (SSE may be deprecated later this year)."),
|
|
251
|
+
serverDocumentationLink: z.url().describe("Public docs URL covering what the MCP does, setup, debugging, and self-serve support. The Alpic playground may be used."),
|
|
252
|
+
privacyPolicyUrl: z.url().describe("URL to your privacy policy. Mandatory and displayed alongside the directory listing."),
|
|
253
|
+
supportChannel: supportChannelSchema.describe("Link or email for user support (help center, GitHub issues, docs, support@…). Displayed alongside the directory listing."),
|
|
254
|
+
testingCredentials: z.string().describe("Credentials for reviewers to verify functionality. Required if the server uses OAuth. No 2FA. Use mcp-review@anthropic.com if an accessible email is needed."),
|
|
255
|
+
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
256
|
+
toolTitlesAnnotationsConfirmed: z.boolean().describe("Confirmation that all tools have user-friendly titles and accurate annotations (readOnlyHint, destructiveHint, …)."),
|
|
257
|
+
logoLight: z.string().describe("Server/app logo for light mode. Square 1:1 aspect ratio. SVG preferred for Claude."),
|
|
258
|
+
screenshots: z.array(z.url()).describe("URLs of screenshots of the connector on Claude.ai or promo material. 3–5 ideal. ≥1000px width preferred, PNG, cropped to the app response. Videos welcome.")
|
|
259
|
+
});
|
|
260
|
+
claudeSubmissionFormDataSchema.pick({
|
|
261
|
+
companyName: true,
|
|
262
|
+
appName: true,
|
|
263
|
+
mcpUrlType: true,
|
|
264
|
+
serverUrl: true,
|
|
265
|
+
tools: true,
|
|
266
|
+
readWriteCapabilities: true,
|
|
267
|
+
transportSupport: true,
|
|
268
|
+
primaryContactEmail: true,
|
|
269
|
+
primaryContactName: true
|
|
270
|
+
}).partial();
|
|
271
|
+
const submissionMetaFieldsSchema = z.object({
|
|
272
|
+
id: z.string(),
|
|
273
|
+
environmentId: z.string(),
|
|
274
|
+
createdAt: z.coerce.date(),
|
|
275
|
+
updatedAt: z.coerce.date()
|
|
276
|
+
});
|
|
277
|
+
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
278
|
+
platform: z.literal("claudeai"),
|
|
279
|
+
formData: claudeSubmissionFormDataSchema.partial()
|
|
280
|
+
});
|
|
281
|
+
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
282
|
+
platform: z.literal("chatgpt"),
|
|
283
|
+
formData: chatgptSubmissionFormDataSchema.partial()
|
|
284
|
+
});
|
|
285
|
+
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
286
|
+
z.union([claudeSubmissionFormDataSchema.partial(), chatgptSubmissionFormDataSchema.partial()]);
|
|
287
|
+
const subscriptionPlanSchema = z.enum([
|
|
288
|
+
"pro",
|
|
289
|
+
"business",
|
|
290
|
+
"enterprise"
|
|
291
|
+
]);
|
|
292
|
+
z.object({ plan: subscriptionPlanSchema.nullable() });
|
|
293
|
+
//#endregion
|
|
4
294
|
//#region src/schemas.ts
|
|
5
295
|
const RESERVED_KEYS = [
|
|
6
296
|
"_HANDLER",
|
|
@@ -35,7 +325,8 @@ const RESERVED_KEYS = [
|
|
|
35
325
|
"BUILD_ARG_BUILD_OUTPUT_DIR",
|
|
36
326
|
"BUILD_ARG_START_COMMAND",
|
|
37
327
|
"ALPIC_HOST",
|
|
38
|
-
"ALPIC_CUSTOM_DOMAINS"
|
|
328
|
+
"ALPIC_CUSTOM_DOMAINS",
|
|
329
|
+
"ALPIC_INTENT_META_KEY"
|
|
39
330
|
];
|
|
40
331
|
const environmentVariableSchema = z.object({
|
|
41
332
|
key: z.string().min(2, "Key must be at least 2 characters").regex(/^[a-zA-Z]([a-zA-Z0-9_])+$/, "Key must start with a letter and contain only letters, numbers, and underscores").refine((key) => !RESERVED_KEYS.includes(key), "This key is reserved and cannot be used as an environment variable key"),
|
|
@@ -43,6 +334,10 @@ const environmentVariableSchema = z.object({
|
|
|
43
334
|
isSecret: z.boolean().default(false)
|
|
44
335
|
});
|
|
45
336
|
const environmentVariablesSchema = z.array(environmentVariableSchema);
|
|
337
|
+
const updateEnvironmentVariableSchema = environmentVariableSchema.partial({
|
|
338
|
+
value: true,
|
|
339
|
+
isSecret: true
|
|
340
|
+
});
|
|
46
341
|
const buildSettingsSchema = z.object({
|
|
47
342
|
installCommand: z.string().optional(),
|
|
48
343
|
buildCommand: z.string().optional(),
|
|
@@ -60,68 +355,15 @@ const transportSchema = z.enum([
|
|
|
60
355
|
"sse",
|
|
61
356
|
"streamablehttp"
|
|
62
357
|
]);
|
|
63
|
-
const
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
]);
|
|
69
|
-
const platformSchema = z.enum(["chatgpt", "claudeai"]);
|
|
70
|
-
const checkSeveritySchema = z.enum([
|
|
71
|
-
"error",
|
|
72
|
-
"warning",
|
|
73
|
-
"info"
|
|
74
|
-
]);
|
|
75
|
-
const checkCategorySchema = z.enum([
|
|
76
|
-
"connectivity",
|
|
77
|
-
"tool-metadata",
|
|
78
|
-
"resource-metadata",
|
|
79
|
-
"performance",
|
|
80
|
-
"e2e"
|
|
81
|
-
]);
|
|
82
|
-
const checkScopeSchema = z.enum(["server", "view"]);
|
|
83
|
-
const checkDetailSchema = z.object({
|
|
84
|
-
label: z.string(),
|
|
85
|
-
value: z.string().optional()
|
|
86
|
-
});
|
|
87
|
-
const checkResultSchema = z.object({
|
|
88
|
-
checkId: z.string(),
|
|
89
|
-
status: z.enum([
|
|
90
|
-
"pass",
|
|
91
|
-
"fail",
|
|
92
|
-
"skip",
|
|
93
|
-
"pending"
|
|
94
|
-
]),
|
|
95
|
-
message: z.string(),
|
|
96
|
-
skipReason: z.string().optional(),
|
|
97
|
-
severity: checkSeveritySchema,
|
|
98
|
-
category: checkCategorySchema,
|
|
99
|
-
scope: checkScopeSchema,
|
|
100
|
-
platforms: z.array(platformSchema).readonly().optional(),
|
|
101
|
-
durationMs: z.number(),
|
|
102
|
-
details: z.array(checkDetailSchema).optional(),
|
|
103
|
-
hint: z.object({ text: z.string() }).optional()
|
|
358
|
+
const playgroundHeaderSchema = z.object({
|
|
359
|
+
name: z.string().min(1).max(100),
|
|
360
|
+
description: z.string().max(200),
|
|
361
|
+
isRequired: z.boolean().default(false),
|
|
362
|
+
isSecret: z.boolean().default(false)
|
|
104
363
|
});
|
|
105
|
-
const
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
targetUrl: z.string(),
|
|
109
|
-
startedAt: z.string(),
|
|
110
|
-
completedAt: z.string(),
|
|
111
|
-
durationMs: z.number(),
|
|
112
|
-
results: z.array(checkResultSchema),
|
|
113
|
-
requiresAuth: z.boolean(),
|
|
114
|
-
hasViewSupport: z.boolean(),
|
|
115
|
-
viewPlatforms: z.array(platformSchema).readonly().optional(),
|
|
116
|
-
isReadyForPlatform: z.record(platformSchema, z.boolean()),
|
|
117
|
-
widgetScreenshotKeys: z.object({
|
|
118
|
-
chatgpt: z.string().optional(),
|
|
119
|
-
claudeai: z.string().optional()
|
|
120
|
-
}).optional(),
|
|
121
|
-
widgetScreenshots: z.object({
|
|
122
|
-
chatgpt: z.object({ url: z.string() }).optional(),
|
|
123
|
-
claudeai: z.object({ url: z.string() }).optional()
|
|
124
|
-
}).optional()
|
|
364
|
+
const playgroundExamplePromptSchema = z.object({
|
|
365
|
+
title: z.string().min(1).max(100),
|
|
366
|
+
prompt: z.string().min(1).max(500)
|
|
125
367
|
});
|
|
126
368
|
const serverFieldsSchema = z.object({
|
|
127
369
|
$schema: z.string(),
|
|
@@ -361,7 +603,7 @@ const updateEnvironmentVariableContractV1 = oc.route({
|
|
|
361
603
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
362
604
|
key: environmentVariableSchema.shape.key,
|
|
363
605
|
value: environmentVariableSchema.shape.value.optional(),
|
|
364
|
-
isSecret: environmentVariableSchema.shape.isSecret
|
|
606
|
+
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
365
607
|
})).output(z.object({ success: z.literal(true) }));
|
|
366
608
|
const deleteEnvironmentVariableContractV1 = oc.route({
|
|
367
609
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
@@ -372,7 +614,7 @@ const deleteEnvironmentVariableContractV1 = oc.route({
|
|
|
372
614
|
successDescription: "The environment variable has been deleted successfully"
|
|
373
615
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
374
616
|
const deleteProjectContractV1 = oc.route({
|
|
375
|
-
path: "/v1/projects
|
|
617
|
+
path: "/v1/projects/{projectId}",
|
|
376
618
|
method: "DELETE",
|
|
377
619
|
summary: "Delete a project",
|
|
378
620
|
description: "Delete a project and all its environments",
|
|
@@ -481,6 +723,41 @@ const getLogsContractV1 = oc.route({
|
|
|
481
723
|
})),
|
|
482
724
|
nextToken: z.string().nullable()
|
|
483
725
|
}));
|
|
726
|
+
const getLatestLogsContractV1 = oc.route({
|
|
727
|
+
path: "/v1/environments/{environmentId}/latest-logs",
|
|
728
|
+
method: "GET",
|
|
729
|
+
summary: "Get latest logs",
|
|
730
|
+
description: "Get the N most recent logs for an environment",
|
|
731
|
+
tags: ["environments"],
|
|
732
|
+
successDescription: "The latest logs"
|
|
733
|
+
}).errors({
|
|
734
|
+
NOT_FOUND: {},
|
|
735
|
+
BAD_REQUEST: {}
|
|
736
|
+
}).input(z.object({
|
|
737
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
738
|
+
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
739
|
+
level: z.array(z.enum([
|
|
740
|
+
"INFO",
|
|
741
|
+
"ERROR",
|
|
742
|
+
"WARNING",
|
|
743
|
+
"DEBUG"
|
|
744
|
+
])).optional().describe("Filter by log level"),
|
|
745
|
+
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
746
|
+
})).output(z.object({ logs: z.array(z.object({
|
|
747
|
+
timestamp: z.coerce.date(),
|
|
748
|
+
type: z.enum([
|
|
749
|
+
"START",
|
|
750
|
+
"END",
|
|
751
|
+
"INFO",
|
|
752
|
+
"ERROR",
|
|
753
|
+
"WARNING",
|
|
754
|
+
"DEBUG"
|
|
755
|
+
]),
|
|
756
|
+
requestId: z.string(),
|
|
757
|
+
content: z.string().optional(),
|
|
758
|
+
method: z.string().optional(),
|
|
759
|
+
durationInMs: z.number().optional()
|
|
760
|
+
})) }));
|
|
484
761
|
const getDeploymentLogsContractV1 = oc.route({
|
|
485
762
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
486
763
|
method: "GET",
|
|
@@ -590,35 +867,77 @@ const getServerInfoContractV1 = oc.route({
|
|
|
590
867
|
projectId: z.string(),
|
|
591
868
|
domain: z.string()
|
|
592
869
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
870
|
+
const playgroundServerMetadataOutputSchema = z.object({
|
|
871
|
+
name: z.string(),
|
|
872
|
+
description: z.string(),
|
|
873
|
+
headers: z.array(z.object({
|
|
874
|
+
name: z.string(),
|
|
875
|
+
description: z.string(),
|
|
876
|
+
isRequired: z.boolean(),
|
|
877
|
+
isSecret: z.boolean()
|
|
878
|
+
})),
|
|
879
|
+
examplePrompts: z.array(playgroundExamplePromptSchema)
|
|
880
|
+
});
|
|
881
|
+
const playgroundOutputSchema = z.object({
|
|
882
|
+
isPlaygroundEnabled: z.boolean(),
|
|
883
|
+
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
884
|
+
});
|
|
885
|
+
const getPlaygroundContractV1 = oc.route({
|
|
886
|
+
path: "/v1/environments/{environmentId}/playground",
|
|
887
|
+
method: "GET",
|
|
888
|
+
summary: "Get playground configuration",
|
|
889
|
+
description: "Get the playground configuration for an environment",
|
|
890
|
+
tags: ["environments"],
|
|
891
|
+
successDescription: "The playground configuration"
|
|
892
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
893
|
+
const upsertPlaygroundContractV1 = oc.route({
|
|
894
|
+
path: "/v1/environments/{environmentId}/playground",
|
|
895
|
+
method: "PUT",
|
|
896
|
+
summary: "Update playground configuration",
|
|
897
|
+
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
898
|
+
tags: ["environments"],
|
|
899
|
+
successDescription: "The updated playground configuration"
|
|
900
|
+
}).errors({
|
|
901
|
+
NOT_FOUND: {},
|
|
902
|
+
BAD_REQUEST: {}
|
|
903
|
+
}).input(z.object({
|
|
904
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
905
|
+
isPlaygroundEnabled: z.boolean().optional(),
|
|
906
|
+
name: z.string().min(1).max(100).optional(),
|
|
907
|
+
description: z.string().min(1).max(500).optional(),
|
|
908
|
+
headers: z.array(playgroundHeaderSchema).optional(),
|
|
909
|
+
examplePrompts: z.array(playgroundExamplePromptSchema).max(3).optional()
|
|
910
|
+
})).output(playgroundOutputSchema);
|
|
593
911
|
const createBeaconContractV1 = oc.route({
|
|
594
|
-
path: "/v1/beacon/
|
|
912
|
+
path: "/v1/beacon/audits",
|
|
595
913
|
method: "POST",
|
|
596
|
-
summary: "Create a beacon
|
|
597
|
-
description: "
|
|
914
|
+
summary: "Create a beacon audit",
|
|
915
|
+
description: "Audit an MCP server for spec compliance and AI client compatibility",
|
|
598
916
|
tags: ["beacon"],
|
|
599
|
-
successDescription: "The
|
|
917
|
+
successDescription: "The audit has been created"
|
|
600
918
|
}).errors({
|
|
601
919
|
NOT_FOUND: {},
|
|
602
920
|
BAD_REQUEST: {}
|
|
603
921
|
}).input(z.object({
|
|
604
|
-
targetUrl: z.
|
|
605
|
-
teamId: z.string().optional().describe("The team ID to associate the
|
|
606
|
-
projectId: z.string().optional().describe("The project ID to associate the
|
|
922
|
+
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
923
|
+
teamId: z.string().optional().describe("The team ID to associate the audit with"),
|
|
924
|
+
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
925
|
+
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
607
926
|
})).output(z.object({ id: z.string() }));
|
|
608
927
|
const getBeaconContractV1 = oc.route({
|
|
609
|
-
path: "/v1/beacon/
|
|
928
|
+
path: "/v1/beacon/audits/{auditId}",
|
|
610
929
|
method: "GET",
|
|
611
|
-
summary: "Get a beacon
|
|
612
|
-
description: "Get a beacon
|
|
930
|
+
summary: "Get a beacon audit",
|
|
931
|
+
description: "Get a beacon audit by ID, including the report if completed",
|
|
613
932
|
tags: ["beacon"],
|
|
614
|
-
successDescription: "The
|
|
615
|
-
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
933
|
+
successDescription: "The audit details"
|
|
934
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ auditId: z.string().describe("The ID of the audit") })).output(z.object({
|
|
616
935
|
id: z.string(),
|
|
617
936
|
targetUrl: z.string(),
|
|
618
|
-
status:
|
|
937
|
+
status: auditStatusSchema,
|
|
619
938
|
durationMs: z.number().nullable(),
|
|
620
939
|
createdAt: z.coerce.date(),
|
|
621
|
-
report:
|
|
940
|
+
report: auditReportWithScreenshotsSchema.nullable()
|
|
622
941
|
}));
|
|
623
942
|
const contract = {
|
|
624
943
|
teams: { list: { v1: listTeamsContractV1 } },
|
|
@@ -633,7 +952,8 @@ const contract = {
|
|
|
633
952
|
create: { v1: createEnvironmentContractV1 },
|
|
634
953
|
get: { v1: getEnvironmentContractV1 },
|
|
635
954
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
636
|
-
getLogs: { v1: getLogsContractV1 }
|
|
955
|
+
getLogs: { v1: getLogsContractV1 },
|
|
956
|
+
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
637
957
|
},
|
|
638
958
|
environmentVariables: {
|
|
639
959
|
list: { v1: listEnvironmentVariablesContractV1 },
|
|
@@ -648,6 +968,10 @@ const contract = {
|
|
|
648
968
|
create: { v1: createProjectContractV1 },
|
|
649
969
|
delete: { v1: deleteProjectContractV1 }
|
|
650
970
|
},
|
|
971
|
+
playground: {
|
|
972
|
+
get: { v1: getPlaygroundContractV1 },
|
|
973
|
+
upsert: { v1: upsertPlaygroundContractV1 }
|
|
974
|
+
},
|
|
651
975
|
tunnels: { getTicket: { v1: getTunnelTicketContractV1 } },
|
|
652
976
|
distribution: {
|
|
653
977
|
publish: { v1: publishServerContractV1 },
|
|
@@ -659,4 +983,4 @@ const contract = {
|
|
|
659
983
|
}
|
|
660
984
|
};
|
|
661
985
|
//#endregion
|
|
662
|
-
export {
|
|
986
|
+
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, 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.7f06d79",
|
|
4
4
|
"description": "Contract for the Alpic API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.mjs",
|
|
@@ -14,20 +14,32 @@
|
|
|
14
14
|
"files": [
|
|
15
15
|
"dist"
|
|
16
16
|
],
|
|
17
|
+
"nx": {
|
|
18
|
+
"targets": {
|
|
19
|
+
"build": {
|
|
20
|
+
"dependsOn": [
|
|
21
|
+
"^build"
|
|
22
|
+
]
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
},
|
|
17
26
|
"author": "Alpic",
|
|
18
27
|
"license": "ISC",
|
|
19
28
|
"dependencies": {
|
|
20
|
-
"@orpc/contract": "^1.
|
|
29
|
+
"@orpc/contract": "^1.14.3",
|
|
21
30
|
"ms": "^2.1.3",
|
|
22
|
-
"zod": "^4.3
|
|
31
|
+
"zod": "^4.4.3"
|
|
23
32
|
},
|
|
24
33
|
"devDependencies": {
|
|
34
|
+
"@orpc/openapi": "^1.14.3",
|
|
35
|
+
"@orpc/zod": "^1.14.3",
|
|
25
36
|
"@total-typescript/tsconfig": "^1.0.4",
|
|
26
37
|
"@types/ms": "^2.1.0",
|
|
27
38
|
"shx": "^0.4.0",
|
|
28
|
-
"tsdown": "^0.
|
|
29
|
-
"typescript": "^
|
|
30
|
-
"vitest": "^4.1.
|
|
39
|
+
"tsdown": "^0.22.0",
|
|
40
|
+
"typescript": "^6.0.3",
|
|
41
|
+
"vitest": "^4.1.6",
|
|
42
|
+
"@alpic-ai/domains": "0.0.0"
|
|
31
43
|
},
|
|
32
44
|
"scripts": {
|
|
33
45
|
"build": "shx rm -rf dist && tsdown",
|