@alpic-ai/api 1.101.0 → 1.102.0

package/dist/index.d.mts

@@ -11,9 +11,9 @@ type ApiContext = {
   };
 };
 declare const deploymentStatusSchema: z.ZodEnum<{
+  failed: "failed";
   ongoing: "ongoing";
   deployed: "deployed";
-  failed: "failed";
   canceled: "canceled";
 }>;
 declare const createEnvironmentContractV1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
@@ -103,18 +103,18 @@ declare const contract: {
       v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
         projectId: z.ZodString;
         status: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+          failed: "failed";
           ongoing: "ongoing";
           deployed: "deployed";
-          failed: "failed";
           canceled: "canceled";
         }>>>;
         environmentId: z.ZodOptional<z.ZodString>;
       }, z.core.$strip>, z.ZodArray<z.ZodObject<{
         id: z.ZodString;
         status: z.ZodEnum<{
+          failed: "failed";
           ongoing: "ongoing";
           deployed: "deployed";
-          failed: "failed";
           canceled: "canceled";
         }>;
         sourceRef: z.ZodNullable<z.ZodString>;
@@ -138,9 +138,9 @@ declare const contract: {
       }, z.core.$strip>, z.ZodObject<{
         id: z.ZodString;
         status: z.ZodEnum<{
+          failed: "failed";
           ongoing: "ongoing";
           deployed: "deployed";
-          failed: "failed";
           canceled: "canceled";
         }>;
         sourceRef: z.ZodNullable<z.ZodString>;
@@ -226,9 +226,9 @@ declare const contract: {
       }, z.core.$strip>, z.ZodObject<{
         id: z.ZodString;
         status: z.ZodEnum<{
+          failed: "failed";
           ongoing: "ongoing";
           deployed: "deployed";
-          failed: "failed";
           canceled: "canceled";
         }>;
         sourceRef: z.ZodNullable<z.ZodString>;
@@ -371,18 +371,18 @@ declare const contract: {
           domains: z.ZodArray<z.ZodObject<{
             domain: z.ZodString;
             status: z.ZodEnum<{
+              failed: "failed";
               ongoing: "ongoing";
               deployed: "deployed";
-              failed: "failed";
             }>;
             createdAt: z.ZodCoercedDate<unknown>;
           }, z.core.$strip>>;
           latestDeployment: z.ZodNullable<z.ZodObject<{
             id: z.ZodString;
             status: z.ZodEnum<{
+              failed: "failed";
               ongoing: "ongoing";
               deployed: "deployed";
-              failed: "failed";
               canceled: "canceled";
             }>;
             sourceCommitId: z.ZodNullable<z.ZodString>;
@@ -400,9 +400,9 @@ declare const contract: {
           latestDeployment: z.ZodNullable<z.ZodObject<{
             id: z.ZodString;
             status: z.ZodEnum<{
+              failed: "failed";
               ongoing: "ongoing";
               deployed: "deployed";
-              failed: "failed";
               canceled: "canceled";
             }>;
             sourceCommitId: z.ZodNullable<z.ZodString>;
@@ -447,18 +447,18 @@ declare const contract: {
           domains: z.ZodArray<z.ZodObject<{
             domain: z.ZodString;
             status: z.ZodEnum<{
+              failed: "failed";
               ongoing: "ongoing";
               deployed: "deployed";
-              failed: "failed";
             }>;
             createdAt: z.ZodCoercedDate<unknown>;
           }, z.core.$strip>>;
           latestDeployment: z.ZodNullable<z.ZodObject<{
             id: z.ZodString;
             status: z.ZodEnum<{
+              failed: "failed";
               ongoing: "ongoing";
               deployed: "deployed";
-              failed: "failed";
               canceled: "canceled";
             }>;
             sourceCommitId: z.ZodNullable<z.ZodString>;
@@ -476,9 +476,9 @@ declare const contract: {
           latestDeployment: z.ZodNullable<z.ZodObject<{
             id: z.ZodString;
             status: z.ZodEnum<{
+              failed: "failed";
               ongoing: "ongoing";
               deployed: "deployed";
-              failed: "failed";
               canceled: "canceled";
             }>;
             sourceCommitId: z.ZodNullable<z.ZodString>;
@@ -522,18 +522,18 @@ declare const contract: {
           domains: z.ZodArray<z.ZodObject<{
             domain: z.ZodString;
             status: z.ZodEnum<{
+              failed: "failed";
               ongoing: "ongoing";
               deployed: "deployed";
-              failed: "failed";
             }>;
             createdAt: z.ZodCoercedDate<unknown>;
           }, z.core.$strip>>;
           latestDeployment: z.ZodNullable<z.ZodObject<{
             id: z.ZodString;
             status: z.ZodEnum<{
+              failed: "failed";
               ongoing: "ongoing";
               deployed: "deployed";
-              failed: "failed";
               canceled: "canceled";
             }>;
             sourceCommitId: z.ZodNullable<z.ZodString>;
@@ -551,9 +551,9 @@ declare const contract: {
           latestDeployment: z.ZodNullable<z.ZodObject<{
             id: z.ZodString;
             status: z.ZodEnum<{
+              failed: "failed";
               ongoing: "ongoing";
               deployed: "deployed";
-              failed: "failed";
               canceled: "canceled";
             }>;
             sourceCommitId: z.ZodNullable<z.ZodString>;
@@ -719,6 +719,107 @@ declare const contract: {
       }>, Record<never, never>>;
     };
   };
+  beacon: {
+    create: {
+      v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+        targetUrl: z.ZodString;
+        teamId: z.ZodOptional<z.ZodString>;
+        projectId: z.ZodOptional<z.ZodString>;
+      }, z.core.$strip>, z.ZodObject<{
+        id: z.ZodString;
+      }, z.core.$strip>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
+        NOT_FOUND: {};
+        BAD_REQUEST: {};
+      }>, Record<never, never>>;
+    };
+    get: {
+      v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+        analysisId: z.ZodString;
+      }, z.core.$strip>, z.ZodObject<{
+        id: z.ZodString;
+        targetUrl: z.ZodString;
+        status: z.ZodEnum<{
+          pending: "pending";
+          partial: "partial";
+          completed: "completed";
+          failed: "failed";
+        }>;
+        durationMs: z.ZodNullable<z.ZodNumber>;
+        createdAt: z.ZodCoercedDate<unknown>;
+        report: z.ZodNullable<z.ZodObject<{
+          schemaVersion: z.ZodString;
+          auditId: z.ZodString;
+          targetUrl: z.ZodString;
+          startedAt: z.ZodString;
+          completedAt: z.ZodString;
+          durationMs: z.ZodNumber;
+          results: z.ZodArray<z.ZodObject<{
+            checkId: z.ZodString;
+            status: z.ZodEnum<{
+              pending: "pending";
+              pass: "pass";
+              fail: "fail";
+              skip: "skip";
+            }>;
+            message: z.ZodString;
+            skipReason: z.ZodOptional<z.ZodString>;
+            severity: z.ZodEnum<{
+              error: "error";
+              warning: "warning";
+              info: "info";
+            }>;
+            category: z.ZodEnum<{
+              connectivity: "connectivity";
+              "tool-metadata": "tool-metadata";
+              "resource-metadata": "resource-metadata";
+              performance: "performance";
+              e2e: "e2e";
+            }>;
+            scope: z.ZodEnum<{
+              server: "server";
+              view: "view";
+            }>;
+            platforms: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+              chatgpt: "chatgpt";
+              claudeai: "claudeai";
+            }>>>>;
+            durationMs: z.ZodNumber;
+            details: z.ZodOptional<z.ZodArray<z.ZodObject<{
+              label: z.ZodString;
+              value: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>>;
+            hint: z.ZodOptional<z.ZodObject<{
+              text: z.ZodString;
+            }, z.core.$strip>>;
+          }, z.core.$strip>>;
+          requiresAuth: z.ZodBoolean;
+          hasViewSupport: z.ZodBoolean;
+          viewPlatforms: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+            chatgpt: "chatgpt";
+            claudeai: "claudeai";
+          }>>>>;
+          isReadyForPlatform: z.ZodRecord<z.ZodEnum<{
+            chatgpt: "chatgpt";
+            claudeai: "claudeai";
+          }>, z.ZodBoolean>;
+          widgetScreenshotKeys: z.ZodOptional<z.ZodObject<{
+            chatgpt: z.ZodOptional<z.ZodString>;
+            claudeai: z.ZodOptional<z.ZodString>;
+          }, z.core.$strip>>;
+          widgetScreenshots: z.ZodOptional<z.ZodObject<{
+            chatgpt: z.ZodOptional<z.ZodObject<{
+              url: z.ZodString;
+            }, z.core.$strip>>;
+            claudeai: z.ZodOptional<z.ZodObject<{
+              url: z.ZodString;
+            }, z.core.$strip>>;
+          }, z.core.$strip>>;
+        }, z.core.$strip>>;
+      }, z.core.$strip>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
+        NOT_FOUND: {};
+      }>, Record<never, never>>;
+    };
+  };
 };
 type RouterInput = InferContractRouterInputs<typeof contract>;
 type RouterOutput = InferContractRouterOutputs<typeof contract>;
@@ -753,6 +854,151 @@ declare const transportSchema: z.ZodEnum<{
   streamablehttp: "streamablehttp";
 }>;
 type Transport = z.infer<typeof transportSchema>;
+declare const analysisStatusSchema: z.ZodEnum<{
+  pending: "pending";
+  partial: "partial";
+  completed: "completed";
+  failed: "failed";
+}>;
+declare const platformSchema: z.ZodEnum<{
+  chatgpt: "chatgpt";
+  claudeai: "claudeai";
+}>;
+type Platform = z.infer<typeof platformSchema>;
+declare const checkSeveritySchema: z.ZodEnum<{
+  error: "error";
+  warning: "warning";
+  info: "info";
+}>;
+type CheckSeverity = z.infer<typeof checkSeveritySchema>;
+declare const checkCategorySchema: z.ZodEnum<{
+  connectivity: "connectivity";
+  "tool-metadata": "tool-metadata";
+  "resource-metadata": "resource-metadata";
+  performance: "performance";
+  e2e: "e2e";
+}>;
+type CheckCategory = z.infer<typeof checkCategorySchema>;
+declare const checkScopeSchema: z.ZodEnum<{
+  server: "server";
+  view: "view";
+}>;
+type CheckScope = z.infer<typeof checkScopeSchema>;
+declare const checkDetailSchema: z.ZodObject<{
+  label: z.ZodString;
+  value: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type CheckDetail = z.infer<typeof checkDetailSchema>;
+declare const checkResultSchema: z.ZodObject<{
+  checkId: z.ZodString;
+  status: z.ZodEnum<{
+    pending: "pending";
+    pass: "pass";
+    fail: "fail";
+    skip: "skip";
+  }>;
+  message: z.ZodString;
+  skipReason: z.ZodOptional<z.ZodString>;
+  severity: z.ZodEnum<{
+    error: "error";
+    warning: "warning";
+    info: "info";
+  }>;
+  category: z.ZodEnum<{
+    connectivity: "connectivity";
+    "tool-metadata": "tool-metadata";
+    "resource-metadata": "resource-metadata";
+    performance: "performance";
+    e2e: "e2e";
+  }>;
+  scope: z.ZodEnum<{
+    server: "server";
+    view: "view";
+  }>;
+  platforms: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+    chatgpt: "chatgpt";
+    claudeai: "claudeai";
+  }>>>>;
+  durationMs: z.ZodNumber;
+  details: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    label: z.ZodString;
+    value: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>>;
+  hint: z.ZodOptional<z.ZodObject<{
+    text: z.ZodString;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+type CheckResult = z.infer<typeof checkResultSchema>;
+declare const auditReportSchema: z.ZodObject<{
+  schemaVersion: z.ZodString;
+  auditId: z.ZodString;
+  targetUrl: z.ZodString;
+  startedAt: z.ZodString;
+  completedAt: z.ZodString;
+  durationMs: z.ZodNumber;
+  results: z.ZodArray<z.ZodObject<{
+    checkId: z.ZodString;
+    status: z.ZodEnum<{
+      pending: "pending";
+      pass: "pass";
+      fail: "fail";
+      skip: "skip";
+    }>;
+    message: z.ZodString;
+    skipReason: z.ZodOptional<z.ZodString>;
+    severity: z.ZodEnum<{
+      error: "error";
+      warning: "warning";
+      info: "info";
+    }>;
+    category: z.ZodEnum<{
+      connectivity: "connectivity";
+      "tool-metadata": "tool-metadata";
+      "resource-metadata": "resource-metadata";
+      performance: "performance";
+      e2e: "e2e";
+    }>;
+    scope: z.ZodEnum<{
+      server: "server";
+      view: "view";
+    }>;
+    platforms: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+      chatgpt: "chatgpt";
+      claudeai: "claudeai";
+    }>>>>;
+    durationMs: z.ZodNumber;
+    details: z.ZodOptional<z.ZodArray<z.ZodObject<{
+      label: z.ZodString;
+      value: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    hint: z.ZodOptional<z.ZodObject<{
+      text: z.ZodString;
+    }, z.core.$strip>>;
+  }, z.core.$strip>>;
+  requiresAuth: z.ZodBoolean;
+  hasViewSupport: z.ZodBoolean;
+  viewPlatforms: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+    chatgpt: "chatgpt";
+    claudeai: "claudeai";
+  }>>>>;
+  isReadyForPlatform: z.ZodRecord<z.ZodEnum<{
+    chatgpt: "chatgpt";
+    claudeai: "claudeai";
+  }>, z.ZodBoolean>;
+  widgetScreenshotKeys: z.ZodOptional<z.ZodObject<{
+    chatgpt: z.ZodOptional<z.ZodString>;
+    claudeai: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+  widgetScreenshots: z.ZodOptional<z.ZodObject<{
+    chatgpt: z.ZodOptional<z.ZodObject<{
+      url: z.ZodString;
+    }, z.core.$strip>>;
+    claudeai: z.ZodOptional<z.ZodObject<{
+      url: z.ZodString;
+    }, z.core.$strip>>;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+type AuditReport = z.infer<typeof auditReportSchema>;
 declare const serverFieldsSchema: z.ZodObject<{
   $schema: z.ZodString;
   name: z.ZodString;
@@ -777,4 +1023,4 @@ declare const serverFieldsSchema: z.ZodObject<{
   }, z.core.$strip>>>;
 }, z.core.$strip>;
 //#endregion
-export { ApiContext, RouterInput, RouterOutput, Runtime, Transport, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, runtimeSchema, serverFieldsSchema, transportSchema };
+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 };

package/dist/index.mjs

@@ -60,6 +60,69 @@ const transportSchema = z.enum([
 	"sse",
 	"streamablehttp"
 ]);
+const analysisStatusSchema = 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"
+]);
+const checkScopeSchema = z.enum(["server", "view"]);
+const checkDetailSchema = z.object({
+	label: z.string(),
+	value: z.string().optional()
+});
+const checkResultSchema = z.object({
+	checkId: 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 serverFieldsSchema = z.object({
 	$schema: z.string(),
 	name: z.string(),
@@ -527,6 +590,36 @@ const getServerInfoContractV1 = oc.route({
 	projectId: z.string(),
 	domain: z.string()
 })).output(z.object({ serverFields: serverFieldsSchema }));
+const createBeaconContractV1 = oc.route({
+	path: "/v1/beacon/analyses",
+	method: "POST",
+	summary: "Create a beacon analysis",
+	description: "Analyze an MCP server for spec compliance and AI client compatibility",
+	tags: ["beacon"],
+	successDescription: "The analysis 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")
+})).output(z.object({ id: z.string() }));
+const getBeaconContractV1 = oc.route({
+	path: "/v1/beacon/analyses/{analysisId}",
+	method: "GET",
+	summary: "Get a beacon analysis",
+	description: "Get a beacon analysis 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({
+	id: z.string(),
+	targetUrl: z.string(),
+	status: analysisStatusSchema,
+	durationMs: z.number().nullable(),
+	createdAt: z.coerce.date(),
+	report: auditReportSchema.nullable()
+}));
 const contract = {
 	teams: { list: { v1: listTeamsContractV1 } },
 	analytics: { get: { v1: getProjectAnalyticsContractV1 } },
@@ -559,7 +652,11 @@ const contract = {
 	distribution: {
 		publish: { v1: publishServerContractV1 },
 		get: { v1: getServerInfoContractV1 }
+	},
+	beacon: {
+		create: { v1: createBeaconContractV1 },
+		get: { v1: getBeaconContractV1 }
 	}
 };
 //#endregion
-export { buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, runtimeSchema, serverFieldsSchema, transportSchema };
+export { analysisStatusSchema, auditReportSchema, buildSettingsSchema, checkDetailSchema, checkResultSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, platformSchema, runtimeSchema, serverFieldsSchema, transportSchema };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alpic-ai/api",
-  "version": "1.101.0",
+  "version": "1.102.0",
   "description": "Contract for the Alpic API",
   "type": "module",
   "main": "./dist/index.mjs",