@alpic-ai/api 0.0.0-staging.a817dc7 → 0.0.0-staging.a82001f
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 +514 -31
- package/dist/index.mjs +434 -28
- package/package.json +24 -10
package/dist/index.mjs
CHANGED
|
@@ -1,6 +1,77 @@
|
|
|
1
|
-
import { oc } from "@orpc/contract";
|
|
2
1
|
import { z } from "zod";
|
|
3
|
-
|
|
2
|
+
import { oc } from "@orpc/contract";
|
|
3
|
+
import ms from "ms";
|
|
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
|
+
//#endregion
|
|
4
75
|
//#region src/schemas.ts
|
|
5
76
|
const RESERVED_KEYS = [
|
|
6
77
|
"_HANDLER",
|
|
@@ -13,7 +84,11 @@ const RESERVED_KEYS = [
|
|
|
13
84
|
"AWS_LAMBDA_FUNCTION_VERSION",
|
|
14
85
|
"AWS_LAMBDA_INITIALIZATION_TYPE",
|
|
15
86
|
"AWS_LAMBDA_LOG_GROUP_NAME",
|
|
87
|
+
"AWS_LAMBDA_LOG_STREAM_NAME",
|
|
16
88
|
"AWS_ACCESS_KEY",
|
|
89
|
+
"AWS_ACCESS_KEY_ID",
|
|
90
|
+
"AWS_SECRET_ACCESS_KEY",
|
|
91
|
+
"AWS_SESSION_TOKEN",
|
|
17
92
|
"AWS_LAMBDA_RUNTIME_API",
|
|
18
93
|
"LAMBDA_TASK_ROOT",
|
|
19
94
|
"LAMBDA_RUNTIME_DIR",
|
|
@@ -30,7 +105,9 @@ const RESERVED_KEYS = [
|
|
|
30
105
|
"BUILD_ARG_BUILD_COMMAND",
|
|
31
106
|
"BUILD_ARG_BUILD_OUTPUT_DIR",
|
|
32
107
|
"BUILD_ARG_START_COMMAND",
|
|
33
|
-
"ALPIC_HOST"
|
|
108
|
+
"ALPIC_HOST",
|
|
109
|
+
"ALPIC_CUSTOM_DOMAINS",
|
|
110
|
+
"ALPIC_INTENT_META_KEY"
|
|
34
111
|
];
|
|
35
112
|
const environmentVariableSchema = z.object({
|
|
36
113
|
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"),
|
|
@@ -38,6 +115,10 @@ const environmentVariableSchema = z.object({
|
|
|
38
115
|
isSecret: z.boolean().default(false)
|
|
39
116
|
});
|
|
40
117
|
const environmentVariablesSchema = z.array(environmentVariableSchema);
|
|
118
|
+
const updateEnvironmentVariableSchema = environmentVariableSchema.partial({
|
|
119
|
+
value: true,
|
|
120
|
+
isSecret: true
|
|
121
|
+
});
|
|
41
122
|
const buildSettingsSchema = z.object({
|
|
42
123
|
installCommand: z.string().optional(),
|
|
43
124
|
buildCommand: z.string().optional(),
|
|
@@ -55,7 +136,39 @@ const transportSchema = z.enum([
|
|
|
55
136
|
"sse",
|
|
56
137
|
"streamablehttp"
|
|
57
138
|
]);
|
|
58
|
-
|
|
139
|
+
const playgroundHeaderSchema = z.object({
|
|
140
|
+
name: z.string().min(1).max(100),
|
|
141
|
+
description: z.string().max(200),
|
|
142
|
+
isRequired: z.boolean().default(false),
|
|
143
|
+
isSecret: z.boolean().default(false)
|
|
144
|
+
});
|
|
145
|
+
const playgroundExamplePromptSchema = z.object({
|
|
146
|
+
title: z.string().min(1).max(100),
|
|
147
|
+
prompt: z.string().min(1).max(500)
|
|
148
|
+
});
|
|
149
|
+
const serverFieldsSchema = z.object({
|
|
150
|
+
$schema: z.string(),
|
|
151
|
+
name: z.string(),
|
|
152
|
+
description: z.string(),
|
|
153
|
+
version: z.string().optional(),
|
|
154
|
+
title: z.string().optional(),
|
|
155
|
+
websiteUrl: z.url().optional(),
|
|
156
|
+
icons: z.array(z.object({
|
|
157
|
+
src: z.url(),
|
|
158
|
+
mimeType: z.string().optional(),
|
|
159
|
+
sizes: z.array(z.string()).optional()
|
|
160
|
+
})).optional(),
|
|
161
|
+
remotes: z.array(z.object({
|
|
162
|
+
type: z.string(),
|
|
163
|
+
url: z.url().optional(),
|
|
164
|
+
headers: z.array(z.object({
|
|
165
|
+
name: z.string(),
|
|
166
|
+
description: z.string(),
|
|
167
|
+
isRequired: z.boolean().optional(),
|
|
168
|
+
isSecret: z.boolean().optional()
|
|
169
|
+
})).optional()
|
|
170
|
+
})).optional()
|
|
171
|
+
});
|
|
59
172
|
//#endregion
|
|
60
173
|
//#region src/api.contract.ts
|
|
61
174
|
const deploymentStatusSchema = z.enum([
|
|
@@ -80,8 +193,16 @@ const deploymentSchema = z.object({
|
|
|
80
193
|
authorUsername: z.string().nullable(),
|
|
81
194
|
authorAvatarUrl: z.string().nullable(),
|
|
82
195
|
startedAt: z.coerce.date().nullable(),
|
|
83
|
-
completedAt: z.coerce.date().nullable()
|
|
196
|
+
completedAt: z.coerce.date().nullable(),
|
|
197
|
+
environmentId: z.string(),
|
|
198
|
+
environmentName: z.string(),
|
|
199
|
+
isCurrent: z.boolean(),
|
|
200
|
+
deploymentPageUrl: z.url().nullable()
|
|
84
201
|
});
|
|
202
|
+
const isValidLogTimeInput = (value) => {
|
|
203
|
+
if (ms(value) !== void 0) return true;
|
|
204
|
+
return !Number.isNaN(new Date(value).getTime());
|
|
205
|
+
};
|
|
85
206
|
const createEnvironmentContractV1 = oc.route({
|
|
86
207
|
path: "/v1/environments",
|
|
87
208
|
method: "POST",
|
|
@@ -106,7 +227,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
106
227
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
107
228
|
}));
|
|
108
229
|
const getEnvironmentContractV1 = oc.route({
|
|
109
|
-
path: "/v1/environments
|
|
230
|
+
path: "/v1/environments/{environmentId}",
|
|
110
231
|
method: "GET",
|
|
111
232
|
summary: "Get an environment",
|
|
112
233
|
description: "Get an environment by ID",
|
|
@@ -121,10 +242,20 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
121
242
|
createdAt: z.coerce.date(),
|
|
122
243
|
projectId: z.string()
|
|
123
244
|
}));
|
|
245
|
+
const domainSchema = z.object({
|
|
246
|
+
domain: z.string(),
|
|
247
|
+
status: z.enum([
|
|
248
|
+
"ongoing",
|
|
249
|
+
"deployed",
|
|
250
|
+
"failed"
|
|
251
|
+
]),
|
|
252
|
+
createdAt: z.coerce.date()
|
|
253
|
+
});
|
|
124
254
|
const productionEnvironmentSchema = z.object({
|
|
125
255
|
id: z.string(),
|
|
126
256
|
name: z.string(),
|
|
127
257
|
mcpServerUrl: z.string(),
|
|
258
|
+
domains: z.array(domainSchema),
|
|
128
259
|
latestDeployment: latestDeploymentSchema.nullable()
|
|
129
260
|
});
|
|
130
261
|
const environmentSchema = z.object({
|
|
@@ -153,7 +284,7 @@ const projectOutputSchema = z.object({
|
|
|
153
284
|
environments: z.array(environmentSchema)
|
|
154
285
|
});
|
|
155
286
|
const getProjectContractV1 = oc.route({
|
|
156
|
-
path: "/v1/projects
|
|
287
|
+
path: "/v1/projects/{projectId}",
|
|
157
288
|
method: "GET",
|
|
158
289
|
summary: "Get a project",
|
|
159
290
|
description: "Get a project by ID",
|
|
@@ -167,7 +298,7 @@ const listProjectsContractV1 = oc.route({
|
|
|
167
298
|
description: "List all projects for a team",
|
|
168
299
|
tags: ["projects"],
|
|
169
300
|
successDescription: "The list of projects"
|
|
170
|
-
}).output(z.array(projectOutputSchema));
|
|
301
|
+
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
171
302
|
const createProjectContractV1 = oc.route({
|
|
172
303
|
path: "/v1/projects",
|
|
173
304
|
method: "POST",
|
|
@@ -180,7 +311,7 @@ const createProjectContractV1 = oc.route({
|
|
|
180
311
|
BAD_REQUEST: {}
|
|
181
312
|
}).input(z.object({
|
|
182
313
|
teamId: z.string().optional(),
|
|
183
|
-
name: z.string().min(1).max(100),
|
|
314
|
+
name: z.string().trim().min(1).max(100),
|
|
184
315
|
sourceRepository: z.string().optional(),
|
|
185
316
|
branchName: z.string().min(1).optional(),
|
|
186
317
|
runtime: runtimeSchema,
|
|
@@ -210,8 +341,69 @@ const createProjectContractV1 = oc.route({
|
|
|
210
341
|
startCommand: z.string().nullable(),
|
|
211
342
|
createdAt: z.coerce.date()
|
|
212
343
|
}));
|
|
344
|
+
const environmentVariableOutputSchema = z.object({
|
|
345
|
+
id: z.string(),
|
|
346
|
+
key: z.string(),
|
|
347
|
+
value: z.string(),
|
|
348
|
+
isSecret: z.boolean(),
|
|
349
|
+
createdAt: z.coerce.date()
|
|
350
|
+
});
|
|
351
|
+
const listEnvironmentVariablesContractV1 = oc.route({
|
|
352
|
+
path: "/v1/environments/{environmentId}/environment-variables",
|
|
353
|
+
method: "GET",
|
|
354
|
+
summary: "List environment variables",
|
|
355
|
+
description: "List all environment variables for an environment",
|
|
356
|
+
tags: ["environments"],
|
|
357
|
+
successDescription: "The list of environment variables"
|
|
358
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
359
|
+
const createEnvironmentVariablesContractV1 = oc.route({
|
|
360
|
+
path: "/v1/environments/{environmentId}/environment-variables",
|
|
361
|
+
method: "POST",
|
|
362
|
+
summary: "Add environment variables",
|
|
363
|
+
description: "Add one or more environment variables to an environment",
|
|
364
|
+
tags: ["environments"],
|
|
365
|
+
successDescription: "The environment variables have been added successfully"
|
|
366
|
+
}).errors({
|
|
367
|
+
NOT_FOUND: {},
|
|
368
|
+
BAD_REQUEST: {}
|
|
369
|
+
}).input(z.object({
|
|
370
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
371
|
+
environmentVariables: environmentVariablesSchema
|
|
372
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
373
|
+
const updateEnvironmentVariableContractV1 = oc.route({
|
|
374
|
+
path: "/v1/environment-variables/{environmentVariableId}",
|
|
375
|
+
method: "PATCH",
|
|
376
|
+
summary: "Update an environment variable",
|
|
377
|
+
description: "Update an environment variable by ID",
|
|
378
|
+
tags: ["environments"],
|
|
379
|
+
successDescription: "The environment variable has been updated successfully"
|
|
380
|
+
}).errors({
|
|
381
|
+
NOT_FOUND: {},
|
|
382
|
+
BAD_REQUEST: {}
|
|
383
|
+
}).input(z.object({
|
|
384
|
+
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
385
|
+
key: environmentVariableSchema.shape.key,
|
|
386
|
+
value: environmentVariableSchema.shape.value.optional(),
|
|
387
|
+
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
388
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
389
|
+
const deleteEnvironmentVariableContractV1 = oc.route({
|
|
390
|
+
path: "/v1/environment-variables/{environmentVariableId}",
|
|
391
|
+
method: "DELETE",
|
|
392
|
+
summary: "Delete an environment variable",
|
|
393
|
+
description: "Delete an environment variable by ID",
|
|
394
|
+
tags: ["environments"],
|
|
395
|
+
successDescription: "The environment variable has been deleted successfully"
|
|
396
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
397
|
+
const deleteProjectContractV1 = oc.route({
|
|
398
|
+
path: "/v1/projects/{projectId}",
|
|
399
|
+
method: "DELETE",
|
|
400
|
+
summary: "Delete a project",
|
|
401
|
+
description: "Delete a project and all its environments",
|
|
402
|
+
tags: ["projects"],
|
|
403
|
+
successDescription: "The project has been deleted successfully"
|
|
404
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
213
405
|
const updateProjectContractV1 = oc.route({
|
|
214
|
-
path: "/v1/projects
|
|
406
|
+
path: "/v1/projects/{projectId}",
|
|
215
407
|
method: "PATCH",
|
|
216
408
|
summary: "Update a project",
|
|
217
409
|
description: "Update project settings",
|
|
@@ -222,10 +414,11 @@ const updateProjectContractV1 = oc.route({
|
|
|
222
414
|
BAD_REQUEST: {}
|
|
223
415
|
}).input(z.object({
|
|
224
416
|
projectId: z.string().describe("The ID of the project"),
|
|
417
|
+
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
225
418
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
226
419
|
})).output(projectOutputSchema);
|
|
227
420
|
const deployEnvironmentContractV1 = oc.route({
|
|
228
|
-
path: "/v1/environments
|
|
421
|
+
path: "/v1/environments/{environmentId}/deploy",
|
|
229
422
|
method: "POST",
|
|
230
423
|
summary: "Deploy an environment",
|
|
231
424
|
description: "Deploy an environment",
|
|
@@ -246,31 +439,108 @@ const uploadDeploymentArtifactContractV1 = oc.route({
|
|
|
246
439
|
tags: ["deployments"],
|
|
247
440
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
248
441
|
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
249
|
-
uploadUrl: z.
|
|
442
|
+
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
250
443
|
token: z.string().describe("Token to identify the source archive"),
|
|
251
444
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
252
445
|
}));
|
|
253
|
-
const
|
|
254
|
-
path: "/v1/projects
|
|
446
|
+
const listDeploymentsContractV1 = oc.route({
|
|
447
|
+
path: "/v1/projects/{projectId}/deployments",
|
|
255
448
|
method: "GET",
|
|
256
449
|
summary: "List project deployments",
|
|
257
450
|
description: "List all deployments for a project",
|
|
258
451
|
tags: ["deployments"],
|
|
259
452
|
successDescription: "The list of deployments"
|
|
260
|
-
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
453
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
454
|
+
projectId: z.string().describe("The ID of the project"),
|
|
455
|
+
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
456
|
+
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
457
|
+
})).output(z.array(deploymentSchema));
|
|
264
458
|
const getDeploymentContractV1 = oc.route({
|
|
265
|
-
path: "/v1/deployments
|
|
459
|
+
path: "/v1/deployments/{deploymentId}",
|
|
266
460
|
method: "GET",
|
|
267
461
|
summary: "Get a deployment",
|
|
268
462
|
description: "Get a deployment by ID",
|
|
269
463
|
tags: ["deployments"],
|
|
270
464
|
successDescription: "The deployment details"
|
|
271
465
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
466
|
+
const getLogsContractV1 = oc.route({
|
|
467
|
+
path: "/v1/environments/{environmentId}/logs",
|
|
468
|
+
method: "GET",
|
|
469
|
+
summary: "Get logs",
|
|
470
|
+
description: "Get logs for an environment",
|
|
471
|
+
tags: ["environments"],
|
|
472
|
+
successDescription: "The logs"
|
|
473
|
+
}).errors({
|
|
474
|
+
NOT_FOUND: {},
|
|
475
|
+
BAD_REQUEST: {}
|
|
476
|
+
}).input(z.object({
|
|
477
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
478
|
+
since: z.string().refine(isValidLogTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." }).optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
479
|
+
until: z.string().refine(isValidLogTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." }).optional().describe("End time — ISO 8601 or relative"),
|
|
480
|
+
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
481
|
+
level: z.array(z.enum([
|
|
482
|
+
"INFO",
|
|
483
|
+
"ERROR",
|
|
484
|
+
"WARNING",
|
|
485
|
+
"DEBUG"
|
|
486
|
+
])).optional().describe("Filter by log level"),
|
|
487
|
+
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
488
|
+
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
489
|
+
})).output(z.object({
|
|
490
|
+
logs: z.array(z.object({
|
|
491
|
+
timestamp: z.coerce.date(),
|
|
492
|
+
type: z.enum([
|
|
493
|
+
"START",
|
|
494
|
+
"END",
|
|
495
|
+
"INFO",
|
|
496
|
+
"ERROR",
|
|
497
|
+
"WARNING",
|
|
498
|
+
"DEBUG"
|
|
499
|
+
]),
|
|
500
|
+
requestId: z.string(),
|
|
501
|
+
content: z.string().optional(),
|
|
502
|
+
method: z.string().optional(),
|
|
503
|
+
durationInMs: z.number().optional()
|
|
504
|
+
})),
|
|
505
|
+
nextToken: z.string().nullable()
|
|
506
|
+
}));
|
|
507
|
+
const getLatestLogsContractV1 = oc.route({
|
|
508
|
+
path: "/v1/environments/{environmentId}/latest-logs",
|
|
509
|
+
method: "GET",
|
|
510
|
+
summary: "Get latest logs",
|
|
511
|
+
description: "Get the N most recent logs for an environment",
|
|
512
|
+
tags: ["environments"],
|
|
513
|
+
successDescription: "The latest logs"
|
|
514
|
+
}).errors({
|
|
515
|
+
NOT_FOUND: {},
|
|
516
|
+
BAD_REQUEST: {}
|
|
517
|
+
}).input(z.object({
|
|
518
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
519
|
+
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
520
|
+
level: z.array(z.enum([
|
|
521
|
+
"INFO",
|
|
522
|
+
"ERROR",
|
|
523
|
+
"WARNING",
|
|
524
|
+
"DEBUG"
|
|
525
|
+
])).optional().describe("Filter by log level"),
|
|
526
|
+
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
527
|
+
})).output(z.object({ logs: z.array(z.object({
|
|
528
|
+
timestamp: z.coerce.date(),
|
|
529
|
+
type: z.enum([
|
|
530
|
+
"START",
|
|
531
|
+
"END",
|
|
532
|
+
"INFO",
|
|
533
|
+
"ERROR",
|
|
534
|
+
"WARNING",
|
|
535
|
+
"DEBUG"
|
|
536
|
+
]),
|
|
537
|
+
requestId: z.string(),
|
|
538
|
+
content: z.string().optional(),
|
|
539
|
+
method: z.string().optional(),
|
|
540
|
+
durationInMs: z.number().optional()
|
|
541
|
+
})) }));
|
|
272
542
|
const getDeploymentLogsContractV1 = oc.route({
|
|
273
|
-
path: "/v1/deployments
|
|
543
|
+
path: "/v1/deployments/{deploymentId}/logs",
|
|
274
544
|
method: "GET",
|
|
275
545
|
summary: "Get deployment logs",
|
|
276
546
|
description: "Get the logs for a deployment",
|
|
@@ -297,7 +567,7 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
297
567
|
task_count: z.array(analyticsDataPointSchema)
|
|
298
568
|
});
|
|
299
569
|
const getProjectAnalyticsContractV1 = oc.route({
|
|
300
|
-
path: "/v1/analytics
|
|
570
|
+
path: "/v1/analytics/{projectId}",
|
|
301
571
|
method: "GET",
|
|
302
572
|
summary: "Get project analytics",
|
|
303
573
|
description: "Get analytics data for a project over a time range",
|
|
@@ -332,14 +602,129 @@ const listTeamsContractV1 = oc.route({
|
|
|
332
602
|
id: z.string(),
|
|
333
603
|
name: z.string(),
|
|
334
604
|
createdAt: z.coerce.date(),
|
|
335
|
-
hasStripeAccount: z.boolean()
|
|
336
|
-
hasActiveSubscription: z.boolean()
|
|
605
|
+
hasStripeAccount: z.boolean()
|
|
337
606
|
})));
|
|
607
|
+
const getTunnelTicketContractV1 = oc.route({
|
|
608
|
+
path: "/v1/tunnels/ticket",
|
|
609
|
+
method: "GET",
|
|
610
|
+
summary: "Get a tunnel ticket",
|
|
611
|
+
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
612
|
+
tags: ["tunnels"],
|
|
613
|
+
successDescription: "The tunnel ticket"
|
|
614
|
+
}).output(z.object({
|
|
615
|
+
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
616
|
+
ticket: z.string().describe("The signed tunnel ticket"),
|
|
617
|
+
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
618
|
+
}));
|
|
619
|
+
const publishServerContractV1 = oc.route({
|
|
620
|
+
path: "/v1/distribution/publish",
|
|
621
|
+
method: "POST",
|
|
622
|
+
summary: "Publish a server to the MCP registry",
|
|
623
|
+
tags: ["distribution"],
|
|
624
|
+
successDescription: "The server has been published successfully"
|
|
625
|
+
}).errors({
|
|
626
|
+
NOT_FOUND: {},
|
|
627
|
+
BAD_REQUEST: {}
|
|
628
|
+
}).input(z.object({
|
|
629
|
+
projectId: z.string(),
|
|
630
|
+
domain: z.string(),
|
|
631
|
+
title: z.string().min(1).max(100),
|
|
632
|
+
description: z.string().min(1).max(100),
|
|
633
|
+
websiteUrl: z.url().max(255).optional(),
|
|
634
|
+
iconSrc: z.url().max(255).optional(),
|
|
635
|
+
dryRun: z.boolean().optional()
|
|
636
|
+
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
637
|
+
const getServerInfoContractV1 = oc.route({
|
|
638
|
+
path: "/v1/distribution/get",
|
|
639
|
+
method: "GET",
|
|
640
|
+
summary: "Get server info",
|
|
641
|
+
description: "Get info about a server",
|
|
642
|
+
tags: ["distribution"],
|
|
643
|
+
successDescription: "The server info"
|
|
644
|
+
}).errors({
|
|
645
|
+
NOT_FOUND: {},
|
|
646
|
+
BAD_REQUEST: {}
|
|
647
|
+
}).input(z.object({
|
|
648
|
+
projectId: z.string(),
|
|
649
|
+
domain: z.string()
|
|
650
|
+
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
651
|
+
const playgroundServerMetadataOutputSchema = z.object({
|
|
652
|
+
name: z.string(),
|
|
653
|
+
description: z.string(),
|
|
654
|
+
headers: z.array(z.object({
|
|
655
|
+
name: z.string(),
|
|
656
|
+
description: z.string(),
|
|
657
|
+
isRequired: z.boolean(),
|
|
658
|
+
isSecret: z.boolean()
|
|
659
|
+
})),
|
|
660
|
+
examplePrompts: z.array(playgroundExamplePromptSchema)
|
|
661
|
+
});
|
|
662
|
+
const playgroundOutputSchema = z.object({
|
|
663
|
+
isPlaygroundEnabled: z.boolean(),
|
|
664
|
+
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
665
|
+
});
|
|
666
|
+
const getPlaygroundContractV1 = oc.route({
|
|
667
|
+
path: "/v1/environments/{environmentId}/playground",
|
|
668
|
+
method: "GET",
|
|
669
|
+
summary: "Get playground configuration",
|
|
670
|
+
description: "Get the playground configuration for an environment",
|
|
671
|
+
tags: ["environments"],
|
|
672
|
+
successDescription: "The playground configuration"
|
|
673
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
674
|
+
const upsertPlaygroundContractV1 = oc.route({
|
|
675
|
+
path: "/v1/environments/{environmentId}/playground",
|
|
676
|
+
method: "PUT",
|
|
677
|
+
summary: "Update playground configuration",
|
|
678
|
+
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
679
|
+
tags: ["environments"],
|
|
680
|
+
successDescription: "The updated playground configuration"
|
|
681
|
+
}).errors({
|
|
682
|
+
NOT_FOUND: {},
|
|
683
|
+
BAD_REQUEST: {}
|
|
684
|
+
}).input(z.object({
|
|
685
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
686
|
+
isPlaygroundEnabled: z.boolean().optional(),
|
|
687
|
+
name: z.string().min(1).max(100).optional(),
|
|
688
|
+
description: z.string().min(1).max(500).optional(),
|
|
689
|
+
headers: z.array(playgroundHeaderSchema).optional(),
|
|
690
|
+
examplePrompts: z.array(playgroundExamplePromptSchema).max(3).optional()
|
|
691
|
+
})).output(playgroundOutputSchema);
|
|
692
|
+
const createBeaconContractV1 = oc.route({
|
|
693
|
+
path: "/v1/beacon/audits",
|
|
694
|
+
method: "POST",
|
|
695
|
+
summary: "Create a beacon audit",
|
|
696
|
+
description: "Audit an MCP server for spec compliance and AI client compatibility",
|
|
697
|
+
tags: ["beacon"],
|
|
698
|
+
successDescription: "The audit has been created"
|
|
699
|
+
}).errors({
|
|
700
|
+
NOT_FOUND: {},
|
|
701
|
+
BAD_REQUEST: {}
|
|
702
|
+
}).input(z.object({
|
|
703
|
+
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
704
|
+
teamId: z.string().optional().describe("The team ID to associate the audit with"),
|
|
705
|
+
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
706
|
+
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
707
|
+
})).output(z.object({ id: z.string() }));
|
|
708
|
+
const getBeaconContractV1 = oc.route({
|
|
709
|
+
path: "/v1/beacon/audits/{auditId}",
|
|
710
|
+
method: "GET",
|
|
711
|
+
summary: "Get a beacon audit",
|
|
712
|
+
description: "Get a beacon audit by ID, including the report if completed",
|
|
713
|
+
tags: ["beacon"],
|
|
714
|
+
successDescription: "The audit details"
|
|
715
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ auditId: z.string().describe("The ID of the audit") })).output(z.object({
|
|
716
|
+
id: z.string(),
|
|
717
|
+
targetUrl: z.string(),
|
|
718
|
+
status: auditStatusSchema,
|
|
719
|
+
durationMs: z.number().nullable(),
|
|
720
|
+
createdAt: z.coerce.date(),
|
|
721
|
+
report: auditReportWithScreenshotsSchema.nullable()
|
|
722
|
+
}));
|
|
338
723
|
const contract = {
|
|
339
724
|
teams: { list: { v1: listTeamsContractV1 } },
|
|
340
725
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
341
726
|
deployments: {
|
|
342
|
-
list: { v1:
|
|
727
|
+
list: { v1: listDeploymentsContractV1 },
|
|
343
728
|
get: { v1: getDeploymentContractV1 },
|
|
344
729
|
uploadArtifact: { v1: uploadDeploymentArtifactContractV1 },
|
|
345
730
|
getLogs: { v1: getDeploymentLogsContractV1 }
|
|
@@ -347,15 +732,36 @@ const contract = {
|
|
|
347
732
|
environments: {
|
|
348
733
|
create: { v1: createEnvironmentContractV1 },
|
|
349
734
|
get: { v1: getEnvironmentContractV1 },
|
|
350
|
-
deploy: { v1: deployEnvironmentContractV1 }
|
|
735
|
+
deploy: { v1: deployEnvironmentContractV1 },
|
|
736
|
+
getLogs: { v1: getLogsContractV1 },
|
|
737
|
+
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
738
|
+
},
|
|
739
|
+
environmentVariables: {
|
|
740
|
+
list: { v1: listEnvironmentVariablesContractV1 },
|
|
741
|
+
create: { v1: createEnvironmentVariablesContractV1 },
|
|
742
|
+
update: { v1: updateEnvironmentVariableContractV1 },
|
|
743
|
+
delete: { v1: deleteEnvironmentVariableContractV1 }
|
|
351
744
|
},
|
|
352
745
|
projects: {
|
|
353
746
|
update: { v1: updateProjectContractV1 },
|
|
354
747
|
get: { v1: getProjectContractV1 },
|
|
355
748
|
list: { v1: listProjectsContractV1 },
|
|
356
|
-
create: { v1: createProjectContractV1 }
|
|
749
|
+
create: { v1: createProjectContractV1 },
|
|
750
|
+
delete: { v1: deleteProjectContractV1 }
|
|
751
|
+
},
|
|
752
|
+
playground: {
|
|
753
|
+
get: { v1: getPlaygroundContractV1 },
|
|
754
|
+
upsert: { v1: upsertPlaygroundContractV1 }
|
|
755
|
+
},
|
|
756
|
+
tunnels: { getTicket: { v1: getTunnelTicketContractV1 } },
|
|
757
|
+
distribution: {
|
|
758
|
+
publish: { v1: publishServerContractV1 },
|
|
759
|
+
get: { v1: getServerInfoContractV1 }
|
|
760
|
+
},
|
|
761
|
+
beacon: {
|
|
762
|
+
create: { v1: createBeaconContractV1 },
|
|
763
|
+
get: { v1: getBeaconContractV1 }
|
|
357
764
|
}
|
|
358
765
|
};
|
|
359
|
-
|
|
360
766
|
//#endregion
|
|
361
|
-
export { buildSettingsSchema, contract, createEnvironmentContractV1, environmentVariableSchema, environmentVariablesSchema, runtimeSchema, transportSchema };
|
|
767
|
+
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.a82001f",
|
|
4
4
|
"description": "Contract for the Alpic API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.mjs",
|
|
@@ -14,26 +14,40 @@
|
|
|
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.
|
|
21
|
-
"
|
|
29
|
+
"@orpc/contract": "^1.14.3",
|
|
30
|
+
"ms": "^2.1.3",
|
|
31
|
+
"zod": "^4.4.3"
|
|
22
32
|
},
|
|
23
33
|
"devDependencies": {
|
|
34
|
+
"@orpc/openapi": "^1.14.3",
|
|
35
|
+
"@orpc/zod": "^1.14.3",
|
|
24
36
|
"@total-typescript/tsconfig": "^1.0.4",
|
|
25
|
-
"
|
|
37
|
+
"@types/ms": "^2.1.0",
|
|
26
38
|
"shx": "^0.4.0",
|
|
27
|
-
"tsdown": "^0.
|
|
28
|
-
"typescript": "^
|
|
29
|
-
"vitest": "^4.
|
|
39
|
+
"tsdown": "^0.22.0",
|
|
40
|
+
"typescript": "^6.0.3",
|
|
41
|
+
"vitest": "^4.1.6",
|
|
42
|
+
"@alpic-ai/domains": "0.0.0"
|
|
30
43
|
},
|
|
31
44
|
"scripts": {
|
|
32
45
|
"build": "shx rm -rf dist && tsdown",
|
|
33
|
-
"format": "biome check --write --error-on-warnings",
|
|
46
|
+
"format": "biome check --write --error-on-warnings .",
|
|
34
47
|
"test": "pnpm run test:unit && pnpm run test:type && pnpm run test:format",
|
|
35
48
|
"test:unit": "vitest run",
|
|
36
|
-
"test:format": "
|
|
37
|
-
"test:type": "tsc --noEmit"
|
|
49
|
+
"test:format": "biome check --error-on-warnings .",
|
|
50
|
+
"test:type": "tsc --noEmit",
|
|
51
|
+
"publish:npm": "pnpm publish --tag \"${NPM_TAG}\" --access public --no-git-checks"
|
|
38
52
|
}
|
|
39
53
|
}
|