@alpic-ai/api 0.0.0-staging.e2ffb8b → 0.0.0-staging.e366eba

package/dist/index.mjs

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import ms from "ms";
 import { z } from "zod";
 //#region src/schemas.ts
 const RESERVED_KEYS = [
@@ -42,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(),
@@ -59,6 +64,105 @@ const transportSchema = z.enum([
 	"sse",
 	"streamablehttp"
 ]);
+const auditStatusSchema = z.enum([
+	"pending",
+	"partial",
+	"completed",
+	"failed"
+]);
+const platformSchema = z.enum(["chatgpt", "claudeai"]);
+const checkSeveritySchema = z.enum([
+	"error",
+	"warning",
+	"info"
+]);
+const checkCategorySchema = z.enum([
+	"connectivity",
+	"tool-metadata",
+	"resource-metadata",
+	"performance",
+	"e2e",
+	"ai-review"
+]);
+const checkScopeSchema = z.enum(["server", "view"]);
+const checkDetailSchema = z.object({
+	label: z.string(),
+	value: z.string().optional()
+});
+const checkResultSchema = z.object({
+	checkId: z.string(),
+	checkName: z.string(),
+	description: z.string(),
+	status: z.enum([
+		"pass",
+		"fail",
+		"skip",
+		"pending"
+	]),
+	message: z.string(),
+	skipReason: z.string().optional(),
+	severity: checkSeveritySchema,
+	category: checkCategorySchema,
+	scope: checkScopeSchema,
+	platforms: z.array(platformSchema).readonly().optional(),
+	durationMs: z.number(),
+	details: z.array(checkDetailSchema).optional(),
+	hint: z.object({ text: z.string() }).optional()
+});
+const auditReportSchema = z.object({
+	schemaVersion: z.string(),
+	auditId: z.string(),
+	targetUrl: z.string(),
+	startedAt: z.string(),
+	completedAt: z.string(),
+	durationMs: z.number(),
+	results: z.array(checkResultSchema),
+	requiresAuth: z.boolean(),
+	hasViewSupport: z.boolean(),
+	viewPlatforms: z.array(platformSchema).readonly().optional(),
+	isReadyForPlatform: z.record(platformSchema, z.boolean()),
+	widgetScreenshotKeys: z.object({
+		chatgpt: z.string().optional(),
+		claudeai: z.string().optional()
+	}).optional(),
+	widgetScreenshots: z.object({
+		chatgpt: z.object({ url: z.string() }).optional(),
+		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(),
+	description: z.string(),
+	version: z.string().optional(),
+	title: z.string().optional(),
+	websiteUrl: z.url().optional(),
+	icons: z.array(z.object({
+		src: z.url(),
+		mimeType: z.string().optional(),
+		sizes: z.array(z.string()).optional()
+	})).optional(),
+	remotes: z.array(z.object({
+		type: z.string(),
+		url: z.url().optional(),
+		headers: z.array(z.object({
+			name: z.string(),
+			description: z.string(),
+			isRequired: z.boolean().optional(),
+			isSecret: z.boolean().optional()
+		})).optional()
+	})).optional()
+});
 //#endregion
 //#region src/api.contract.ts
 const deploymentStatusSchema = z.enum([
@@ -83,9 +187,16 @@ const deploymentSchema = z.object({
 	authorUsername: z.string().nullable(),
 	authorAvatarUrl: z.string().nullable(),
 	startedAt: z.coerce.date().nullable(),
-	completedAt: z.coerce.date().nullable()
+	completedAt: z.coerce.date().nullable(),
+	environmentId: z.string(),
+	environmentName: z.string(),
+	isCurrent: z.boolean(),
+	deploymentPageUrl: z.url().nullable()
 });
-const deploymentWithPageUrlSchema = deploymentSchema.extend({ deploymentPageUrl: z.url().nullable() });
+const isValidLogTimeInput = (value) => {
+	if (ms(value) !== void 0) return true;
+	return !Number.isNaN(new Date(value).getTime());
+};
 const createEnvironmentContractV1 = oc.route({
 	path: "/v1/environments",
 	method: "POST",
@@ -224,8 +335,61 @@ const createProjectContractV1 = oc.route({
 	startCommand: z.string().nullable(),
 	createdAt: z.coerce.date()
 }));
+const environmentVariableOutputSchema = z.object({
+	id: z.string(),
+	key: z.string(),
+	value: z.string(),
+	isSecret: z.boolean(),
+	createdAt: z.coerce.date()
+});
+const listEnvironmentVariablesContractV1 = oc.route({
+	path: "/v1/environments/{environmentId}/environment-variables",
+	method: "GET",
+	summary: "List environment variables",
+	description: "List all environment variables for an environment",
+	tags: ["environments"],
+	successDescription: "The list of environment variables"
+}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
+const createEnvironmentVariablesContractV1 = oc.route({
+	path: "/v1/environments/{environmentId}/environment-variables",
+	method: "POST",
+	summary: "Add environment variables",
+	description: "Add one or more environment variables to an environment",
+	tags: ["environments"],
+	successDescription: "The environment variables have been added successfully"
+}).errors({
+	NOT_FOUND: {},
+	BAD_REQUEST: {}
+}).input(z.object({
+	environmentId: z.string().describe("The ID of the environment"),
+	environmentVariables: environmentVariablesSchema
+})).output(z.object({ success: z.literal(true) }));
+const updateEnvironmentVariableContractV1 = oc.route({
+	path: "/v1/environment-variables/{environmentVariableId}",
+	method: "PATCH",
+	summary: "Update an environment variable",
+	description: "Update an environment variable by ID",
+	tags: ["environments"],
+	successDescription: "The environment variable has been updated successfully"
+}).errors({
+	NOT_FOUND: {},
+	BAD_REQUEST: {}
+}).input(z.object({
+	environmentVariableId: z.string().describe("The ID of the environment variable"),
+	key: environmentVariableSchema.shape.key,
+	value: environmentVariableSchema.shape.value.optional(),
+	isSecret: environmentVariableSchema.shape.isSecret.optional()
+})).output(z.object({ success: z.literal(true) }));
+const deleteEnvironmentVariableContractV1 = oc.route({
+	path: "/v1/environment-variables/{environmentVariableId}",
+	method: "DELETE",
+	summary: "Delete an environment variable",
+	description: "Delete an environment variable by ID",
+	tags: ["environments"],
+	successDescription: "The environment variable has been deleted successfully"
+}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
 const deleteProjectContractV1 = oc.route({
-	path: "/v1/projects/:projectId",
+	path: "/v1/projects/{projectId}",
 	method: "DELETE",
 	summary: "Delete a project",
 	description: "Delete a project and all its environments",
@@ -260,7 +424,7 @@ const deployEnvironmentContractV1 = oc.route({
 }).input(z.object({
 	environmentId: z.string().describe("The ID of the environment to deploy"),
 	token: z.string().describe("The token to identify the source archive").optional()
-})).output(deploymentWithPageUrlSchema);
+})).output(deploymentSchema);
 const uploadDeploymentArtifactContractV1 = oc.route({
 	path: "/v1/deployments/upload",
 	method: "POST",
@@ -269,21 +433,22 @@ const uploadDeploymentArtifactContractV1 = oc.route({
 	tags: ["deployments"],
 	successDescription: "The presigned upload URL has been generated successfully"
 }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
-	uploadUrl: z.string().url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
+	uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
 	token: z.string().describe("Token to identify the source archive"),
 	expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
 }));
-const listProjectDeploymentsContractV1 = oc.route({
+const listDeploymentsContractV1 = oc.route({
 	path: "/v1/projects/{projectId}/deployments",
 	method: "GET",
 	summary: "List project deployments",
 	description: "List all deployments for a project",
 	tags: ["deployments"],
 	successDescription: "The list of deployments"
-}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.array(deploymentSchema.extend({
-	isCurrent: z.boolean(),
-	environmentId: z.string()
-})));
+}).errors({ NOT_FOUND: {} }).input(z.object({
+	projectId: z.string().describe("The ID of the project"),
+	status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
+	environmentId: z.string().optional().describe("Filter by environment ID")
+})).output(z.array(deploymentSchema));
 const getDeploymentContractV1 = oc.route({
 	path: "/v1/deployments/{deploymentId}",
 	method: "GET",
@@ -291,7 +456,83 @@ const getDeploymentContractV1 = oc.route({
 	description: "Get a deployment by ID",
 	tags: ["deployments"],
 	successDescription: "The deployment details"
-}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentWithPageUrlSchema);
+}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
+const getLogsContractV1 = oc.route({
+	path: "/v1/environments/{environmentId}/logs",
+	method: "GET",
+	summary: "Get logs",
+	description: "Get logs for an environment",
+	tags: ["environments"],
+	successDescription: "The logs"
+}).errors({
+	NOT_FOUND: {},
+	BAD_REQUEST: {}
+}).input(z.object({
+	environmentId: z.string().describe("The ID of the environment"),
+	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)"),
+	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"),
+	limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
+	level: z.array(z.enum([
+		"INFO",
+		"ERROR",
+		"WARNING",
+		"DEBUG"
+	])).optional().describe("Filter by log level"),
+	search: z.string().optional().describe("Filter pattern to search for in log content"),
+	nextToken: z.string().optional().describe("Pagination token from a previous response")
+})).output(z.object({
+	logs: z.array(z.object({
+		timestamp: z.coerce.date(),
+		type: z.enum([
+			"START",
+			"END",
+			"INFO",
+			"ERROR",
+			"WARNING",
+			"DEBUG"
+		]),
+		requestId: z.string(),
+		content: z.string().optional(),
+		method: z.string().optional(),
+		durationInMs: z.number().optional()
+	})),
+	nextToken: z.string().nullable()
+}));
+const getLatestLogsContractV1 = oc.route({
+	path: "/v1/environments/{environmentId}/latest-logs",
+	method: "GET",
+	summary: "Get latest logs",
+	description: "Get the N most recent logs for an environment",
+	tags: ["environments"],
+	successDescription: "The latest logs"
+}).errors({
+	NOT_FOUND: {},
+	BAD_REQUEST: {}
+}).input(z.object({
+	environmentId: z.string().describe("The ID of the environment"),
+	limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
+	level: z.array(z.enum([
+		"INFO",
+		"ERROR",
+		"WARNING",
+		"DEBUG"
+	])).optional().describe("Filter by log level"),
+	search: z.string().optional().describe("Filter pattern to search for in log content")
+})).output(z.object({ logs: z.array(z.object({
+	timestamp: z.coerce.date(),
+	type: z.enum([
+		"START",
+		"END",
+		"INFO",
+		"ERROR",
+		"WARNING",
+		"DEBUG"
+	]),
+	requestId: z.string(),
+	content: z.string().optional(),
+	method: z.string().optional(),
+	durationInMs: z.number().optional()
+})) }));
 const getDeploymentLogsContractV1 = oc.route({
 	path: "/v1/deployments/{deploymentId}/logs",
 	method: "GET",
@@ -369,11 +610,115 @@ const getTunnelTicketContractV1 = oc.route({
 	ticket: z.string().describe("The signed tunnel ticket"),
 	tunnelHost: z.string().describe("The tunnel host to connect to")
 }));
+const publishServerContractV1 = oc.route({
+	path: "/v1/distribution/publish",
+	method: "POST",
+	summary: "Publish a server to the MCP registry",
+	tags: ["distribution"],
+	successDescription: "The server has been published successfully"
+}).errors({
+	NOT_FOUND: {},
+	BAD_REQUEST: {}
+}).input(z.object({
+	projectId: z.string(),
+	domain: z.string(),
+	title: z.string().min(1).max(100),
+	description: z.string().min(1).max(100),
+	websiteUrl: z.url().max(255).optional(),
+	iconSrc: z.url().max(255).optional(),
+	dryRun: z.boolean().optional()
+})).output(z.object({ serverFields: serverFieldsSchema }));
+const getServerInfoContractV1 = oc.route({
+	path: "/v1/distribution/get",
+	method: "GET",
+	summary: "Get server info",
+	description: "Get info about a server",
+	tags: ["distribution"],
+	successDescription: "The server info"
+}).errors({
+	NOT_FOUND: {},
+	BAD_REQUEST: {}
+}).input(z.object({
+	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/audits",
+	method: "POST",
+	summary: "Create a beacon audit",
+	description: "Audit an MCP server for spec compliance and AI client compatibility",
+	tags: ["beacon"],
+	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 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/audits/{auditId}",
+	method: "GET",
+	summary: "Get a beacon audit",
+	description: "Get a beacon audit by ID, including the report if completed",
+	tags: ["beacon"],
+	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: auditStatusSchema,
+	durationMs: z.number().nullable(),
+	createdAt: z.coerce.date(),
+	report: auditReportSchema.nullable()
+}));
 const contract = {
 	teams: { list: { v1: listTeamsContractV1 } },
 	analytics: { get: { v1: getProjectAnalyticsContractV1 } },
 	deployments: {
-		list: { v1: listProjectDeploymentsContractV1 },
+		list: { v1: listDeploymentsContractV1 },
 		get: { v1: getDeploymentContractV1 },
 		uploadArtifact: { v1: uploadDeploymentArtifactContractV1 },
 		getLogs: { v1: getDeploymentLogsContractV1 }
@@ -381,7 +726,15 @@ const contract = {
 	environments: {
 		create: { v1: createEnvironmentContractV1 },
 		get: { v1: getEnvironmentContractV1 },
-		deploy: { v1: deployEnvironmentContractV1 }
+		deploy: { v1: deployEnvironmentContractV1 },
+		getLogs: { v1: getLogsContractV1 },
+		getLatestLogs: { v1: getLatestLogsContractV1 }
+	},
+	environmentVariables: {
+		list: { v1: listEnvironmentVariablesContractV1 },
+		create: { v1: createEnvironmentVariablesContractV1 },
+		update: { v1: updateEnvironmentVariableContractV1 },
+		delete: { v1: deleteEnvironmentVariableContractV1 }
 	},
 	projects: {
 		update: { v1: updateProjectContractV1 },
@@ -390,7 +743,19 @@ const contract = {
 		create: { v1: createProjectContractV1 },
 		delete: { v1: deleteProjectContractV1 }
 	},
-	tunnels: { getTicket: { v1: getTunnelTicketContractV1 } }
+	playground: {
+		get: { v1: getPlaygroundContractV1 },
+		upsert: { v1: upsertPlaygroundContractV1 }
+	},
+	tunnels: { getTicket: { v1: getTunnelTicketContractV1 } },
+	distribution: {
+		publish: { v1: publishServerContractV1 },
+		get: { v1: getServerInfoContractV1 }
+	},
+	beacon: {
+		create: { v1: createBeaconContractV1 },
+		get: { v1: getBeaconContractV1 }
+	}
 };
 //#endregion
-export { buildSettingsSchema, contract, createEnvironmentContractV1, environmentVariableSchema, environmentVariablesSchema, runtimeSchema, 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.e2ffb8b",
+  "version": "0.0.0-staging.e366eba",
   "description": "Contract for the Alpic API",
   "type": "module",
   "main": "./dist/index.mjs",
@@ -17,22 +17,25 @@
   "author": "Alpic",
   "license": "ISC",
   "dependencies": {
-    "@orpc/contract": "^1.13.6",
+    "@orpc/contract": "^1.13.14",
+    "ms": "^2.1.3",
     "zod": "^4.3.6"
   },
   "devDependencies": {
     "@total-typescript/tsconfig": "^1.0.4",
+    "@types/ms": "^2.1.0",
     "shx": "^0.4.0",
-    "tsdown": "^0.21.1",
-    "typescript": "^5.9.3",
-    "vitest": "^4.0.18"
+    "tsdown": "^0.21.7",
+    "typescript": "^6.0.2",
+    "vitest": "^4.1.4"
   },
   "scripts": {
     "build": "shx rm -rf dist && tsdown",
-    "format": "biome check --write --error-on-warnings",
+    "format": "biome check --write --error-on-warnings .",
     "test": "pnpm run test:unit && pnpm run test:type && pnpm run test:format",
     "test:unit": "vitest run",
-    "test:format": "prettier --check .",
-    "test:type": "tsc --noEmit"
+    "test:format": "biome check --error-on-warnings .",
+    "test:type": "tsc --noEmit",
+    "publish:npm": "pnpm publish --tag \"${NPM_TAG}\" --access public --no-git-checks"
   }
 }