@alpic-ai/api 0.0.0-staging.94ccacf → 0.0.0-staging.9655f32
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 +54 -4
- package/dist/index.mjs +62 -18
- package/package.json +5 -5
package/dist/index.d.mts
CHANGED
|
@@ -283,6 +283,38 @@ declare const contract: {
|
|
|
283
283
|
BAD_REQUEST: {};
|
|
284
284
|
}>, Record<never, never>>;
|
|
285
285
|
};
|
|
286
|
+
getLatestLogs: {
|
|
287
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
288
|
+
environmentId: z.ZodString;
|
|
289
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
290
|
+
level: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
291
|
+
INFO: "INFO";
|
|
292
|
+
ERROR: "ERROR";
|
|
293
|
+
WARNING: "WARNING";
|
|
294
|
+
DEBUG: "DEBUG";
|
|
295
|
+
}>>>;
|
|
296
|
+
search: z.ZodOptional<z.ZodString>;
|
|
297
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
298
|
+
logs: z.ZodArray<z.ZodObject<{
|
|
299
|
+
timestamp: z.ZodCoercedDate<unknown>;
|
|
300
|
+
type: z.ZodEnum<{
|
|
301
|
+
INFO: "INFO";
|
|
302
|
+
ERROR: "ERROR";
|
|
303
|
+
WARNING: "WARNING";
|
|
304
|
+
DEBUG: "DEBUG";
|
|
305
|
+
START: "START";
|
|
306
|
+
END: "END";
|
|
307
|
+
}>;
|
|
308
|
+
requestId: z.ZodString;
|
|
309
|
+
content: z.ZodOptional<z.ZodString>;
|
|
310
|
+
method: z.ZodOptional<z.ZodString>;
|
|
311
|
+
durationInMs: z.ZodOptional<z.ZodNumber>;
|
|
312
|
+
}, z.core.$strip>>;
|
|
313
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
314
|
+
NOT_FOUND: {};
|
|
315
|
+
BAD_REQUEST: {};
|
|
316
|
+
}>, Record<never, never>>;
|
|
317
|
+
};
|
|
286
318
|
};
|
|
287
319
|
environmentVariables: {
|
|
288
320
|
list: {
|
|
@@ -318,7 +350,7 @@ declare const contract: {
|
|
|
318
350
|
environmentVariableId: z.ZodString;
|
|
319
351
|
key: z.ZodString;
|
|
320
352
|
value: z.ZodOptional<z.ZodString>;
|
|
321
|
-
isSecret: z.ZodDefault<z.ZodBoolean
|
|
353
|
+
isSecret: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
322
354
|
}, z.core.$strip>, z.ZodObject<{
|
|
323
355
|
success: z.ZodLiteral<true>;
|
|
324
356
|
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
@@ -787,6 +819,13 @@ declare const contract: {
|
|
|
787
819
|
targetUrl: z.ZodString;
|
|
788
820
|
teamId: z.ZodOptional<z.ZodString>;
|
|
789
821
|
projectId: z.ZodOptional<z.ZodString>;
|
|
822
|
+
excludeCategories: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
823
|
+
connectivity: "connectivity";
|
|
824
|
+
"tool-metadata": "tool-metadata";
|
|
825
|
+
"resource-metadata": "resource-metadata";
|
|
826
|
+
performance: "performance";
|
|
827
|
+
e2e: "e2e";
|
|
828
|
+
}>>>;
|
|
790
829
|
}, z.core.$strip>, z.ZodObject<{
|
|
791
830
|
id: z.ZodString;
|
|
792
831
|
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
@@ -796,7 +835,7 @@ declare const contract: {
|
|
|
796
835
|
};
|
|
797
836
|
get: {
|
|
798
837
|
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
799
|
-
|
|
838
|
+
auditId: z.ZodString;
|
|
800
839
|
}, z.core.$strip>, z.ZodObject<{
|
|
801
840
|
id: z.ZodString;
|
|
802
841
|
targetUrl: z.ZodString;
|
|
@@ -817,6 +856,8 @@ declare const contract: {
|
|
|
817
856
|
durationMs: z.ZodNumber;
|
|
818
857
|
results: z.ZodArray<z.ZodObject<{
|
|
819
858
|
checkId: z.ZodString;
|
|
859
|
+
checkName: z.ZodString;
|
|
860
|
+
description: z.ZodString;
|
|
820
861
|
status: z.ZodEnum<{
|
|
821
862
|
pending: "pending";
|
|
822
863
|
pass: "pass";
|
|
@@ -897,6 +938,11 @@ declare const environmentVariablesSchema: z.ZodArray<z.ZodObject<{
|
|
|
897
938
|
value: z.ZodString;
|
|
898
939
|
isSecret: z.ZodDefault<z.ZodBoolean>;
|
|
899
940
|
}, z.core.$strip>>;
|
|
941
|
+
declare const updateEnvironmentVariableSchema: z.ZodObject<{
|
|
942
|
+
key: z.ZodString;
|
|
943
|
+
value: z.ZodOptional<z.ZodString>;
|
|
944
|
+
isSecret: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
945
|
+
}, z.core.$strip>;
|
|
900
946
|
declare const buildSettingsSchema: z.ZodObject<{
|
|
901
947
|
installCommand: z.ZodOptional<z.ZodString>;
|
|
902
948
|
buildCommand: z.ZodOptional<z.ZodString>;
|
|
@@ -916,7 +962,7 @@ declare const transportSchema: z.ZodEnum<{
|
|
|
916
962
|
streamablehttp: "streamablehttp";
|
|
917
963
|
}>;
|
|
918
964
|
type Transport = z.infer<typeof transportSchema>;
|
|
919
|
-
declare const
|
|
965
|
+
declare const auditStatusSchema: z.ZodEnum<{
|
|
920
966
|
pending: "pending";
|
|
921
967
|
partial: "partial";
|
|
922
968
|
completed: "completed";
|
|
@@ -953,6 +999,8 @@ declare const checkDetailSchema: z.ZodObject<{
|
|
|
953
999
|
type CheckDetail = z.infer<typeof checkDetailSchema>;
|
|
954
1000
|
declare const checkResultSchema: z.ZodObject<{
|
|
955
1001
|
checkId: z.ZodString;
|
|
1002
|
+
checkName: z.ZodString;
|
|
1003
|
+
description: z.ZodString;
|
|
956
1004
|
status: z.ZodEnum<{
|
|
957
1005
|
pending: "pending";
|
|
958
1006
|
pass: "pass";
|
|
@@ -1000,6 +1048,8 @@ declare const auditReportSchema: z.ZodObject<{
|
|
|
1000
1048
|
durationMs: z.ZodNumber;
|
|
1001
1049
|
results: z.ZodArray<z.ZodObject<{
|
|
1002
1050
|
checkId: z.ZodString;
|
|
1051
|
+
checkName: z.ZodString;
|
|
1052
|
+
description: z.ZodString;
|
|
1003
1053
|
status: z.ZodEnum<{
|
|
1004
1054
|
pending: "pending";
|
|
1005
1055
|
pass: "pass";
|
|
@@ -1095,4 +1145,4 @@ declare const serverFieldsSchema: z.ZodObject<{
|
|
|
1095
1145
|
}, z.core.$strip>>>;
|
|
1096
1146
|
}, z.core.$strip>;
|
|
1097
1147
|
//#endregion
|
|
1098
|
-
export { ApiContext, AuditReport, CheckCategory, CheckDetail, CheckResult, CheckScope, CheckSeverity, Platform, RouterInput, RouterOutput, Runtime, Transport,
|
|
1148
|
+
export { ApiContext, AuditReport, CheckCategory, CheckDetail, CheckResult, CheckScope, CheckSeverity, Platform, RouterInput, RouterOutput, Runtime, Transport, auditReportSchema, auditStatusSchema, buildSettingsSchema, checkCategorySchema, checkDetailSchema, checkResultSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, platformSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
package/dist/index.mjs
CHANGED
|
@@ -35,7 +35,8 @@ const RESERVED_KEYS = [
|
|
|
35
35
|
"BUILD_ARG_BUILD_OUTPUT_DIR",
|
|
36
36
|
"BUILD_ARG_START_COMMAND",
|
|
37
37
|
"ALPIC_HOST",
|
|
38
|
-
"ALPIC_CUSTOM_DOMAINS"
|
|
38
|
+
"ALPIC_CUSTOM_DOMAINS",
|
|
39
|
+
"ALPIC_PROMPT_META_KEY"
|
|
39
40
|
];
|
|
40
41
|
const environmentVariableSchema = z.object({
|
|
41
42
|
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 +44,10 @@ const environmentVariableSchema = z.object({
|
|
|
43
44
|
isSecret: z.boolean().default(false)
|
|
44
45
|
});
|
|
45
46
|
const environmentVariablesSchema = z.array(environmentVariableSchema);
|
|
47
|
+
const updateEnvironmentVariableSchema = environmentVariableSchema.partial({
|
|
48
|
+
value: true,
|
|
49
|
+
isSecret: true
|
|
50
|
+
});
|
|
46
51
|
const buildSettingsSchema = z.object({
|
|
47
52
|
installCommand: z.string().optional(),
|
|
48
53
|
buildCommand: z.string().optional(),
|
|
@@ -60,7 +65,7 @@ const transportSchema = z.enum([
|
|
|
60
65
|
"sse",
|
|
61
66
|
"streamablehttp"
|
|
62
67
|
]);
|
|
63
|
-
const
|
|
68
|
+
const auditStatusSchema = z.enum([
|
|
64
69
|
"pending",
|
|
65
70
|
"partial",
|
|
66
71
|
"completed",
|
|
@@ -86,6 +91,8 @@ const checkDetailSchema = z.object({
|
|
|
86
91
|
});
|
|
87
92
|
const checkResultSchema = z.object({
|
|
88
93
|
checkId: z.string(),
|
|
94
|
+
checkName: z.string(),
|
|
95
|
+
description: z.string(),
|
|
89
96
|
status: z.enum([
|
|
90
97
|
"pass",
|
|
91
98
|
"fail",
|
|
@@ -371,7 +378,7 @@ const updateEnvironmentVariableContractV1 = oc.route({
|
|
|
371
378
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
372
379
|
key: environmentVariableSchema.shape.key,
|
|
373
380
|
value: environmentVariableSchema.shape.value.optional(),
|
|
374
|
-
isSecret: environmentVariableSchema.shape.isSecret
|
|
381
|
+
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
375
382
|
})).output(z.object({ success: z.literal(true) }));
|
|
376
383
|
const deleteEnvironmentVariableContractV1 = oc.route({
|
|
377
384
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
@@ -491,6 +498,41 @@ const getLogsContractV1 = oc.route({
|
|
|
491
498
|
})),
|
|
492
499
|
nextToken: z.string().nullable()
|
|
493
500
|
}));
|
|
501
|
+
const getLatestLogsContractV1 = oc.route({
|
|
502
|
+
path: "/v1/environments/{environmentId}/latest-logs",
|
|
503
|
+
method: "GET",
|
|
504
|
+
summary: "Get latest logs",
|
|
505
|
+
description: "Get the N most recent logs for an environment",
|
|
506
|
+
tags: ["environments"],
|
|
507
|
+
successDescription: "The latest logs"
|
|
508
|
+
}).errors({
|
|
509
|
+
NOT_FOUND: {},
|
|
510
|
+
BAD_REQUEST: {}
|
|
511
|
+
}).input(z.object({
|
|
512
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
513
|
+
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
514
|
+
level: z.array(z.enum([
|
|
515
|
+
"INFO",
|
|
516
|
+
"ERROR",
|
|
517
|
+
"WARNING",
|
|
518
|
+
"DEBUG"
|
|
519
|
+
])).optional().describe("Filter by log level"),
|
|
520
|
+
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
521
|
+
})).output(z.object({ logs: z.array(z.object({
|
|
522
|
+
timestamp: z.coerce.date(),
|
|
523
|
+
type: z.enum([
|
|
524
|
+
"START",
|
|
525
|
+
"END",
|
|
526
|
+
"INFO",
|
|
527
|
+
"ERROR",
|
|
528
|
+
"WARNING",
|
|
529
|
+
"DEBUG"
|
|
530
|
+
]),
|
|
531
|
+
requestId: z.string(),
|
|
532
|
+
content: z.string().optional(),
|
|
533
|
+
method: z.string().optional(),
|
|
534
|
+
durationInMs: z.number().optional()
|
|
535
|
+
})) }));
|
|
494
536
|
const getDeploymentLogsContractV1 = oc.route({
|
|
495
537
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
496
538
|
method: "GET",
|
|
@@ -642,31 +684,32 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
642
684
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(3).optional()
|
|
643
685
|
})).output(playgroundOutputSchema);
|
|
644
686
|
const createBeaconContractV1 = oc.route({
|
|
645
|
-
path: "/v1/beacon/
|
|
687
|
+
path: "/v1/beacon/audits",
|
|
646
688
|
method: "POST",
|
|
647
|
-
summary: "Create a beacon
|
|
648
|
-
description: "
|
|
689
|
+
summary: "Create a beacon audit",
|
|
690
|
+
description: "Audit an MCP server for spec compliance and AI client compatibility",
|
|
649
691
|
tags: ["beacon"],
|
|
650
|
-
successDescription: "The
|
|
692
|
+
successDescription: "The audit has been created"
|
|
651
693
|
}).errors({
|
|
652
694
|
NOT_FOUND: {},
|
|
653
695
|
BAD_REQUEST: {}
|
|
654
696
|
}).input(z.object({
|
|
655
|
-
targetUrl: z.string().url().describe("The HTTPS URL of the MCP server to
|
|
656
|
-
teamId: z.string().optional().describe("The team ID to associate the
|
|
657
|
-
projectId: z.string().optional().describe("The project ID to associate the
|
|
697
|
+
targetUrl: z.string().url().describe("The HTTPS URL of the MCP server to audit"),
|
|
698
|
+
teamId: z.string().optional().describe("The team ID to associate the audit with"),
|
|
699
|
+
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
700
|
+
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
658
701
|
})).output(z.object({ id: z.string() }));
|
|
659
702
|
const getBeaconContractV1 = oc.route({
|
|
660
|
-
path: "/v1/beacon/
|
|
703
|
+
path: "/v1/beacon/audits/{auditId}",
|
|
661
704
|
method: "GET",
|
|
662
|
-
summary: "Get a beacon
|
|
663
|
-
description: "Get a beacon
|
|
705
|
+
summary: "Get a beacon audit",
|
|
706
|
+
description: "Get a beacon audit by ID, including the report if completed",
|
|
664
707
|
tags: ["beacon"],
|
|
665
|
-
successDescription: "The
|
|
666
|
-
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
708
|
+
successDescription: "The audit details"
|
|
709
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ auditId: z.string().describe("The ID of the audit") })).output(z.object({
|
|
667
710
|
id: z.string(),
|
|
668
711
|
targetUrl: z.string(),
|
|
669
|
-
status:
|
|
712
|
+
status: auditStatusSchema,
|
|
670
713
|
durationMs: z.number().nullable(),
|
|
671
714
|
createdAt: z.coerce.date(),
|
|
672
715
|
report: auditReportSchema.nullable()
|
|
@@ -684,7 +727,8 @@ const contract = {
|
|
|
684
727
|
create: { v1: createEnvironmentContractV1 },
|
|
685
728
|
get: { v1: getEnvironmentContractV1 },
|
|
686
729
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
687
|
-
getLogs: { v1: getLogsContractV1 }
|
|
730
|
+
getLogs: { v1: getLogsContractV1 },
|
|
731
|
+
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
688
732
|
},
|
|
689
733
|
environmentVariables: {
|
|
690
734
|
list: { v1: listEnvironmentVariablesContractV1 },
|
|
@@ -714,4 +758,4 @@ const contract = {
|
|
|
714
758
|
}
|
|
715
759
|
};
|
|
716
760
|
//#endregion
|
|
717
|
-
export {
|
|
761
|
+
export { auditReportSchema, auditStatusSchema, buildSettingsSchema, checkCategorySchema, checkDetailSchema, checkResultSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, platformSchema, 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.9655f32",
|
|
4
4
|
"description": "Contract for the Alpic API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.mjs",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"author": "Alpic",
|
|
18
18
|
"license": "ISC",
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@orpc/contract": "^1.13.
|
|
20
|
+
"@orpc/contract": "^1.13.14",
|
|
21
21
|
"ms": "^2.1.3",
|
|
22
22
|
"zod": "^4.3.6"
|
|
23
23
|
},
|
|
@@ -25,9 +25,9 @@
|
|
|
25
25
|
"@total-typescript/tsconfig": "^1.0.4",
|
|
26
26
|
"@types/ms": "^2.1.0",
|
|
27
27
|
"shx": "^0.4.0",
|
|
28
|
-
"tsdown": "^0.21.
|
|
29
|
-
"typescript": "^6.0.
|
|
30
|
-
"vitest": "^4.1.
|
|
28
|
+
"tsdown": "^0.21.9",
|
|
29
|
+
"typescript": "^6.0.3",
|
|
30
|
+
"vitest": "^4.1.4"
|
|
31
31
|
},
|
|
32
32
|
"scripts": {
|
|
33
33
|
"build": "shx rm -rf dist && tsdown",
|