@alpic-ai/api 0.0.0-staging.dccf4e1 → 0.0.0-staging.dcd2ccb

package/dist/index.d.mts

@@ -318,7 +318,7 @@ declare const contract: {
         environmentVariableId: z.ZodString;
         key: z.ZodString;
         value: z.ZodOptional<z.ZodString>;
-        isSecret: z.ZodDefault<z.ZodBoolean>;
+        isSecret: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
       }, z.core.$strip>, z.ZodObject<{
         success: z.ZodLiteral<true>;
       }, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
@@ -637,6 +637,68 @@ declare const contract: {
       }>, Record<never, never>>;
     };
   };
+  playground: {
+    get: {
+      v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+        environmentId: z.ZodString;
+      }, z.core.$strip>, z.ZodObject<{
+        isPlaygroundEnabled: z.ZodBoolean;
+        serverMetadata: z.ZodNullable<z.ZodObject<{
+          name: z.ZodString;
+          description: z.ZodString;
+          headers: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            description: z.ZodString;
+            isRequired: z.ZodBoolean;
+            isSecret: z.ZodBoolean;
+          }, z.core.$strip>>;
+          examplePrompts: z.ZodArray<z.ZodObject<{
+            title: z.ZodString;
+            prompt: z.ZodString;
+          }, z.core.$strip>>;
+        }, z.core.$strip>>;
+      }, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
+        NOT_FOUND: {};
+      }>, Record<never, never>>;
+    };
+    upsert: {
+      v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+        environmentId: z.ZodString;
+        isPlaygroundEnabled: z.ZodOptional<z.ZodBoolean>;
+        name: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        headers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+          name: z.ZodString;
+          description: z.ZodString;
+          isRequired: z.ZodDefault<z.ZodBoolean>;
+          isSecret: z.ZodDefault<z.ZodBoolean>;
+        }, z.core.$strip>>>;
+        examplePrompts: z.ZodOptional<z.ZodArray<z.ZodObject<{
+          title: z.ZodString;
+          prompt: z.ZodString;
+        }, z.core.$strip>>>;
+      }, z.core.$strip>, z.ZodObject<{
+        isPlaygroundEnabled: z.ZodBoolean;
+        serverMetadata: z.ZodNullable<z.ZodObject<{
+          name: z.ZodString;
+          description: z.ZodString;
+          headers: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            description: z.ZodString;
+            isRequired: z.ZodBoolean;
+            isSecret: z.ZodBoolean;
+          }, z.core.$strip>>;
+          examplePrompts: z.ZodArray<z.ZodObject<{
+            title: z.ZodString;
+            prompt: z.ZodString;
+          }, z.core.$strip>>;
+        }, z.core.$strip>>;
+      }, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
+        NOT_FOUND: {};
+        BAD_REQUEST: {};
+      }>, Record<never, never>>;
+    };
+  };
   tunnels: {
     getTicket: {
       v1: _$_orpc_contract0.ContractProcedureBuilderWithOutput<_$_orpc_contract0.Schema<unknown, unknown>, z.ZodObject<{
@@ -725,6 +787,13 @@ declare const contract: {
         targetUrl: z.ZodString;
         teamId: z.ZodOptional<z.ZodString>;
         projectId: z.ZodOptional<z.ZodString>;
+        excludeCategories: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+          connectivity: "connectivity";
+          "tool-metadata": "tool-metadata";
+          "resource-metadata": "resource-metadata";
+          performance: "performance";
+          e2e: "e2e";
+        }>>>;
       }, z.core.$strip>, z.ZodObject<{
         id: z.ZodString;
       }, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
@@ -734,7 +803,7 @@ declare const contract: {
     };
     get: {
       v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
-        analysisId: z.ZodString;
+        auditId: z.ZodString;
       }, z.core.$strip>, z.ZodObject<{
         id: z.ZodString;
         targetUrl: z.ZodString;
@@ -835,6 +904,11 @@ declare const environmentVariablesSchema: z.ZodArray<z.ZodObject<{
   value: z.ZodString;
   isSecret: z.ZodDefault<z.ZodBoolean>;
 }, z.core.$strip>>;
+declare const updateEnvironmentVariableSchema: z.ZodObject<{
+  key: z.ZodString;
+  value: z.ZodOptional<z.ZodString>;
+  isSecret: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+}, z.core.$strip>;
 declare const buildSettingsSchema: z.ZodObject<{
   installCommand: z.ZodOptional<z.ZodString>;
   buildCommand: z.ZodOptional<z.ZodString>;
@@ -854,7 +928,7 @@ declare const transportSchema: z.ZodEnum<{
   streamablehttp: "streamablehttp";
 }>;
 type Transport = z.infer<typeof transportSchema>;
-declare const analysisStatusSchema: z.ZodEnum<{
+declare const auditStatusSchema: z.ZodEnum<{
   pending: "pending";
   partial: "partial";
   completed: "completed";
@@ -999,6 +1073,16 @@ declare const auditReportSchema: z.ZodObject<{
   }, z.core.$strip>>;
 }, z.core.$strip>;
 type AuditReport = z.infer<typeof auditReportSchema>;
+declare const playgroundHeaderSchema: z.ZodObject<{
+  name: z.ZodString;
+  description: z.ZodString;
+  isRequired: z.ZodDefault<z.ZodBoolean>;
+  isSecret: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+declare const playgroundExamplePromptSchema: z.ZodObject<{
+  title: z.ZodString;
+  prompt: z.ZodString;
+}, z.core.$strip>;
 declare const serverFieldsSchema: z.ZodObject<{
   $schema: z.ZodString;
   name: z.ZodString;
@@ -1023,4 +1107,4 @@ declare const serverFieldsSchema: z.ZodObject<{
   }, z.core.$strip>>>;
 }, z.core.$strip>;
 //#endregion
-export { ApiContext, AuditReport, CheckCategory, CheckDetail, CheckResult, CheckScope, CheckSeverity, Platform, RouterInput, RouterOutput, Runtime, Transport, analysisStatusSchema, auditReportSchema, buildSettingsSchema, checkDetailSchema, checkResultSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, platformSchema, runtimeSchema, serverFieldsSchema, transportSchema };
+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

@@ -43,6 +43,10 @@ const environmentVariableSchema = z.object({
 	isSecret: z.boolean().default(false)
 });
 const environmentVariablesSchema = z.array(environmentVariableSchema);
+const updateEnvironmentVariableSchema = environmentVariableSchema.partial({
+	value: true,
+	isSecret: true
+});
 const buildSettingsSchema = z.object({
 	installCommand: z.string().optional(),
 	buildCommand: z.string().optional(),
@@ -60,7 +64,7 @@ const transportSchema = z.enum([
 	"sse",
 	"streamablehttp"
 ]);
-const analysisStatusSchema = z.enum([
+const auditStatusSchema = z.enum([
 	"pending",
 	"partial",
 	"completed",
@@ -123,6 +127,16 @@ const auditReportSchema = z.object({
 		claudeai: z.object({ url: z.string() }).optional()
 	}).optional()
 });
+const playgroundHeaderSchema = z.object({
+	name: z.string().min(1).max(100),
+	description: z.string().max(200),
+	isRequired: z.boolean().default(false),
+	isSecret: z.boolean().default(false)
+});
+const playgroundExamplePromptSchema = z.object({
+	title: z.string().min(1).max(100),
+	prompt: z.string().min(1).max(500)
+});
 const serverFieldsSchema = z.object({
 	$schema: z.string(),
 	name: z.string(),
@@ -361,7 +375,7 @@ const updateEnvironmentVariableContractV1 = oc.route({
 	environmentVariableId: z.string().describe("The ID of the environment variable"),
 	key: environmentVariableSchema.shape.key,
 	value: environmentVariableSchema.shape.value.optional(),
-	isSecret: environmentVariableSchema.shape.isSecret
+	isSecret: environmentVariableSchema.shape.isSecret.optional()
 })).output(z.object({ success: z.literal(true) }));
 const deleteEnvironmentVariableContractV1 = oc.route({
 	path: "/v1/environment-variables/{environmentVariableId}",
@@ -590,32 +604,74 @@ const getServerInfoContractV1 = oc.route({
 	projectId: z.string(),
 	domain: z.string()
 })).output(z.object({ serverFields: serverFieldsSchema }));
+const playgroundServerMetadataOutputSchema = z.object({
+	name: z.string(),
+	description: z.string(),
+	headers: z.array(z.object({
+		name: z.string(),
+		description: z.string(),
+		isRequired: z.boolean(),
+		isSecret: z.boolean()
+	})),
+	examplePrompts: z.array(playgroundExamplePromptSchema)
+});
+const playgroundOutputSchema = z.object({
+	isPlaygroundEnabled: z.boolean(),
+	serverMetadata: playgroundServerMetadataOutputSchema.nullable()
+});
+const getPlaygroundContractV1 = oc.route({
+	path: "/v1/environments/{environmentId}/playground",
+	method: "GET",
+	summary: "Get playground configuration",
+	description: "Get the playground configuration for an environment",
+	tags: ["environments"],
+	successDescription: "The playground configuration"
+}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
+const upsertPlaygroundContractV1 = oc.route({
+	path: "/v1/environments/{environmentId}/playground",
+	method: "PUT",
+	summary: "Update playground configuration",
+	description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
+	tags: ["environments"],
+	successDescription: "The updated playground configuration"
+}).errors({
+	NOT_FOUND: {},
+	BAD_REQUEST: {}
+}).input(z.object({
+	environmentId: z.string().describe("The ID of the environment"),
+	isPlaygroundEnabled: z.boolean().optional(),
+	name: z.string().min(1).max(100).optional(),
+	description: z.string().min(1).max(500).optional(),
+	headers: z.array(playgroundHeaderSchema).optional(),
+	examplePrompts: z.array(playgroundExamplePromptSchema).max(3).optional()
+})).output(playgroundOutputSchema);
 const createBeaconContractV1 = oc.route({
-	path: "/v1/beacon/analyses",
+	path: "/v1/beacon/audits",
 	method: "POST",
-	summary: "Create a beacon analysis",
-	description: "Analyze an MCP server for spec compliance and AI client compatibility",
+	summary: "Create a beacon audit",
+	description: "Audit an MCP server for spec compliance and AI client compatibility",
 	tags: ["beacon"],
-	successDescription: "The analysis has been created"
+	successDescription: "The audit has been created"
 }).errors({
 	NOT_FOUND: {},
 	BAD_REQUEST: {}
 }).input(z.object({
-	targetUrl: z.string().url().describe("The HTTPS URL of the MCP server to analyze"),
-	teamId: z.string().optional().describe("The team ID to associate the analysis with"),
-	projectId: z.string().optional().describe("The project ID to associate the analysis with")
+	targetUrl: z.string().url().describe("The HTTPS URL of the MCP server to audit"),
+	teamId: z.string().optional().describe("The team ID to associate the audit with"),
+	projectId: z.string().optional().describe("The project ID to associate the audit with"),
+	excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
 })).output(z.object({ id: z.string() }));
 const getBeaconContractV1 = oc.route({
-	path: "/v1/beacon/analyses/{analysisId}",
+	path: "/v1/beacon/audits/{auditId}",
 	method: "GET",
-	summary: "Get a beacon analysis",
-	description: "Get a beacon analysis by ID, including the report if completed",
+	summary: "Get a beacon audit",
+	description: "Get a beacon audit by ID, including the report if completed",
 	tags: ["beacon"],
-	successDescription: "The analysis details"
-}).errors({ NOT_FOUND: {} }).input(z.object({ analysisId: z.string().describe("The ID of the analysis") })).output(z.object({
+	successDescription: "The audit details"
+}).errors({ NOT_FOUND: {} }).input(z.object({ auditId: z.string().describe("The ID of the audit") })).output(z.object({
 	id: z.string(),
 	targetUrl: z.string(),
-	status: analysisStatusSchema,
+	status: auditStatusSchema,
 	durationMs: z.number().nullable(),
 	createdAt: z.coerce.date(),
 	report: auditReportSchema.nullable()
@@ -648,6 +704,10 @@ const contract = {
 		create: { v1: createProjectContractV1 },
 		delete: { v1: deleteProjectContractV1 }
 	},
+	playground: {
+		get: { v1: getPlaygroundContractV1 },
+		upsert: { v1: upsertPlaygroundContractV1 }
+	},
 	tunnels: { getTicket: { v1: getTunnelTicketContractV1 } },
 	distribution: {
 		publish: { v1: publishServerContractV1 },
@@ -659,4 +719,4 @@ const contract = {
 	}
 };
 //#endregion
-export { analysisStatusSchema, auditReportSchema, buildSettingsSchema, checkDetailSchema, checkResultSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, platformSchema, runtimeSchema, serverFieldsSchema, transportSchema };
+export { auditReportSchema, auditStatusSchema, buildSettingsSchema, checkCategorySchema, checkDetailSchema, checkResultSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, platformSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alpic-ai/api",
-  "version": "0.0.0-staging.dccf4e1",
+  "version": "0.0.0-staging.dcd2ccb",
   "description": "Contract for the Alpic API",
   "type": "module",
   "main": "./dist/index.mjs",
@@ -26,7 +26,7 @@
     "@types/ms": "^2.1.0",
     "shx": "^0.4.0",
     "tsdown": "^0.21.7",
-    "typescript": "^5.9.3",
+    "typescript": "^6.0.2",
     "vitest": "^4.1.2"
   },
   "scripts": {