@alpic-ai/api 1.127.0 → 1.128.0

package/dist/index.d.mts

@@ -927,7 +927,7 @@ declare const contract: {
 type RouterInput = InferContractRouterInputs<typeof contract>;
 type RouterOutput = InferContractRouterOutputs<typeof contract>;
 //#endregion
-//#region ../domains/src/beacon/schemas.d.ts
+//#region ../domains/src/platforms/schemas.d.ts
 declare const platformSchema: z.ZodEnum<{
   chatgpt: "chatgpt";
   claudeai: "claudeai";

package/dist/index.mjs

@@ -1,18 +1,17 @@
 import { z } from "zod";
 import { oc } from "@orpc/contract";
 import ms from "ms";
-//#region ../domains/dist/index.mjs
+const platformSchema = z.enum(["chatgpt", "claudeai"]);
+const PLATFORM_LABELS = {
+	chatgpt: "ChatGPT",
+	claudeai: "Claude.ai"
+};
 const auditStatusSchema = z.enum([
 	"pending",
 	"partial",
 	"completed",
 	"failed"
 ]);
-const platformSchema = z.enum(["chatgpt", "claudeai"]);
-const PLATFORM_LABELS = {
-	chatgpt: "ChatGPT",
-	claudeai: "Claude.ai"
-};
 const checkSeveritySchema = z.enum([
 	"error",
 	"warning",
@@ -72,6 +71,225 @@ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreen
 	chatgpt: widgetScreenshotSchema.optional(),
 	claudeai: widgetScreenshotSchema.optional()
 }) });
+z.object({
+	id: z.string(),
+	createdAt: z.coerce.date(),
+	environmentId: z.string(),
+	content: z.string(),
+	source: z.enum(["model", "user"])
+});
+z.object({
+	content: z.string(),
+	source: z.enum(["model", "user"])
+});
+const toolDefinitionSchema = z.object({
+	name: z.string(),
+	title: z.string().optional(),
+	description: z.string().optional(),
+	annotations: z.object({
+		readOnlyHint: z.boolean().optional(),
+		destructiveHint: z.boolean().optional(),
+		openWorldHint: z.boolean().optional(),
+		idempotentHint: z.boolean().optional()
+	}).optional()
+});
+const positiveTestCaseSchema = z.object({
+	scenario: z.string(),
+	userPrompt: z.string(),
+	toolTriggered: z.string().optional(),
+	expectedOutput: z.string().optional()
+}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
+/** Accepts either a valid email or URL. */
+const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
+const chatgptCategorySchema = z.enum([
+	"BUSINESS",
+	"COLLABORATION",
+	"DESIGN",
+	"DEVELOPER_TOOLS",
+	"EDUCATION",
+	"ENTERTAINMENT",
+	"FINANCE",
+	"FOOD",
+	"LIFESTYLE",
+	"NEWS",
+	"PRODUCTIVITY",
+	"SHOPPING",
+	"TRAVEL"
+]);
+const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
+const chatgptAllowedCountriesSchema = z.enum(["Allow all", "Restrict to specific countries"]);
+const negativeTestCaseSchema = z.object({
+	scenario: z.string(),
+	userPrompt: z.string()
+}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
+const chatgptToolJustificationSchema = z.object({
+	toolName: z.string(),
+	readOnlyJustification: z.string(),
+	openWorldJustification: z.string(),
+	destructiveJustification: z.string()
+}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
+const chatgptTranslationSchema = z.object({
+	locale: z.string(),
+	tagline: z.string().optional(),
+	description: z.string().optional()
+}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
+/**
+* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
+* When adding/removing/reordering fields, keep this in sync with the sheet.
+*/
+const chatgptSubmissionFormDataSchema = z.object({
+	logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
+	logoDark: z.string().describe("Logo icon for dark mode. Square PNG. Same specs as the light icon."),
+	appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
+	tagline: z.string().max(30).describe("Plain-language phrase focused on function and user value. 30 chars max."),
+	description: z.string().describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
+	category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
+	developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
+	companyUrl: z.url().describe("Your company's main website URL."),
+	supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
+	privacyPolicyUrl: z.url().describe("URL to your privacy policy."),
+	termsOfServiceUrl: z.url().describe("URL to the app's terms of service."),
+	demoRecordingUrl: z.url().describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
+	appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My app links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the app does not offer digital goods."),
+	serverUrl: z.url().describe("URL of the MCP server."),
+	authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
+	tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
+	toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
+	testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Coverage over all major use cases."),
+	negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases — prompts where the app should NOT trigger but the model might think it's relevant."),
+	screenshots: z.array(z.url()).describe("URLs of in-app screenshots. Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 4. First three are public."),
+	translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
+	allowedCountries: chatgptAllowedCountriesSchema.describe("'Allow all' or restrict to a specific list. See OpenAI's supported countries list."),
+	releaseNotes: z.string().describe("Publicly displayed on the app details page.")
+});
+chatgptSubmissionFormDataSchema.pick({
+	appName: true,
+	developerName: true,
+	serverUrl: true,
+	tools: true,
+	authentication: true
+}).partial();
+const claudeCategorySchema = z.enum([
+	"Business & Productivity",
+	"Communication",
+	"Data & Analytics",
+	"Development tools",
+	"Financial Services",
+	"Consumer Health",
+	"Health & Life Sciences",
+	"Media & Entertainment",
+	"Commerce & Shopping"
+]);
+z.enum([
+	"No auth needed",
+	"OAuth 2.0",
+	"Custom URL"
+]);
+const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
+z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
+const claudeReadWriteCapabilitiesSchema = z.enum([
+	"Read only",
+	"Write only",
+	"Read + write"
+]);
+const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
+const claudeThirdPartySchema = z.enum([
+	"Web access (open web fetch / scraping / arbitrary URLs)",
+	"Third-party AI model integration",
+	"Third-party data retrieval (via workflow / aggregator)",
+	"Third-party data modification (via workflow / aggregator)",
+	"N/A"
+]);
+const claudeDataHandlingSchema = z.enum([
+	"Server only accesses data explicitly requested by user",
+	"No data is stored beyond session requirements",
+	"Data transmission is encrypted (HTTPS / TLS)",
+	"GDPR compliant (if applicable)"
+]);
+const claudeSponsoredContentSchema = z.enum([
+	"No, there is no sponsored content or advertisements",
+	"Yes, there are banner ads or other paid visual elements",
+	"Yes, returned content or ranking is impacted by sponsorship or ad placement"
+]);
+/**
+* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
+* When adding/removing/reordering fields, keep this in sync with the sheet.
+*/
+const claudeSubmissionFormDataSchema = z.object({
+	companyName: z.string().describe("Enter your company's legal name or the name under which your product is publicly known. This is used for internal tracking and may appear in directory listings."),
+	companyUrl: z.url().describe("Your company's main website URL, e.g. https://mycompany.com. Must be a valid URL with https://. This should be the root domain of the company behind this MCP server."),
+	primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. This person will receive review feedback, approval notices, and any follow-up questions."),
+	primaryContactEmail: z.email().describe("Business email for the primary contact. Must be a valid email address. Anthropic uses this to communicate about your submission status, required changes, and post-listing issues. Avoid using personal email addresses."),
+	primaryContactRole: z.string().optional().describe("The job title or role of the primary contact (e.g. 'CTO', 'Developer Relations Lead', 'Founder'). Optional but helps Anthropic route questions to the right person."),
+	anthropicPointOfContact: z.string().optional().describe("If you have a direct contact at Anthropic (e.g. from a partnership or sales conversation), enter their name here. This is optional but can greatly help expedite the review process. Leave blank if you don't have one."),
+	appName: z.string().describe(`The public display name for your connector as it will appear in the Connectors Directory.
+
+Rules:
+(1) Do NOT include the words 'MCP' or 'Server' — these are auto-rejected.
+(2) Use your brand/product name, e.g. 'Notion', 'Linear', 'Slack'.
+(3) You must own or have the right to use this brand name. For example, don't call it 'Google Drive Helper' if you're not Google.`),
+	mcpUrlType: claudeMcpUrlTypeSchema.describe("Universal URL = one URL serves all users. Custom MCP URLs = signup URL + regex matching per-user URLs."),
+	serverUrl: z.url().describe("Production MCP server URL (https). Derived from the project's production environment by default."),
+	tagline: z.string().max(55).describe("Short blurb shown below the server name. 55 chars max."),
+	description: z.string().describe("50–100 words describing what the server does and its key capabilities. Lives on the directory listing."),
+	testCases: z.array(positiveTestCaseSchema).describe("At least 3 use cases with example prompts showing the value of the connector."),
+	connectionRequirements: z.string().describe(`Prerequisites before connecting:
+• Free/premium account
+• Admin seat
+• Geographic availability
+• Custom instance URL
+
+State 'No special requirements.' if none.`),
+	readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe("Inferred from the `readOnlyHint` annotations on the MCP tools."),
+	isMcpApp: z.boolean().describe("True if the server exposes interactive UI elements (widgets). Inferred from the MCP connection."),
+	thirdPartyConnectionsAndWebAccess: z.array(claudeThirdPartySchema).describe("Multi-select of what the server reaches out to (web, third-party AI, data aggregators)."),
+	dataHandling: z.array(claudeDataHandlingSchema).describe("Multi-select of data-handling practices that accurately describe the server. Cannot be inferred — user must self-declare."),
+	personalDataHealthAccess: z.boolean().describe("True only if the connector gives users access to their own personal health data (medical records, lab results, health metrics)."),
+	categories: z.array(claudeCategorySchema).describe("Multi-select of categories that best describe the server in the directory."),
+	sponsoredContentsOrAdvertisement: claudeSponsoredContentSchema.describe("Disclose paid promotion or sponsored content. Cannot be filled by Alpic — user must self-declare."),
+	transportSupport: z.array(claudeTransportSchema).describe("Multi-select of transport protocols the server supports. Anthropic recommends Streamable HTTP (SSE may be deprecated later this year)."),
+	serverDocumentationLink: z.url().describe("Public docs URL covering what the MCP does, setup, debugging, and self-serve support. The Alpic playground may be used."),
+	privacyPolicyUrl: z.url().describe("URL to your privacy policy. Mandatory and displayed alongside the directory listing."),
+	supportChannel: supportChannelSchema.describe("Link or email for user support (help center, GitHub issues, docs, support@…). Displayed alongside the directory listing."),
+	testingCredentials: z.string().describe("Credentials for reviewers to verify functionality. Required if the server uses OAuth. No 2FA. Use mcp-review@anthropic.com if an accessible email is needed."),
+	tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
+	toolTitlesAnnotationsConfirmed: z.boolean().describe("Confirmation that all tools have user-friendly titles and accurate annotations (readOnlyHint, destructiveHint, …)."),
+	logoLight: z.string().describe("Server/app logo for light mode. Square 1:1 aspect ratio. SVG preferred for Claude."),
+	screenshots: z.array(z.url()).describe("URLs of screenshots of the connector on Claude.ai or promo material. 3–5 ideal. ≥1000px width preferred, PNG, cropped to the app response. Videos welcome.")
+});
+claudeSubmissionFormDataSchema.pick({
+	companyName: true,
+	appName: true,
+	mcpUrlType: true,
+	serverUrl: true,
+	tools: true,
+	readWriteCapabilities: true,
+	transportSupport: true,
+	primaryContactEmail: true,
+	primaryContactName: true
+}).partial();
+const submissionMetaFieldsSchema = z.object({
+	id: z.string(),
+	environmentId: z.string(),
+	createdAt: z.coerce.date(),
+	updatedAt: z.coerce.date()
+});
+const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
+	platform: z.literal("claudeai"),
+	formData: claudeSubmissionFormDataSchema.partial()
+});
+const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
+	platform: z.literal("chatgpt"),
+	formData: chatgptSubmissionFormDataSchema.partial()
+});
+z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
+z.union([claudeSubmissionFormDataSchema.partial(), chatgptSubmissionFormDataSchema.partial()]);
+const subscriptionPlanSchema = z.enum([
+	"pro",
+	"business",
+	"enterprise"
+]);
+z.object({ plan: subscriptionPlanSchema.nullable() });
 //#endregion
 //#region src/schemas.ts
 const RESERVED_KEYS = [
@@ -108,7 +326,7 @@ const RESERVED_KEYS = [
 	"BUILD_ARG_START_COMMAND",
 	"ALPIC_HOST",
 	"ALPIC_CUSTOM_DOMAINS",
-	"ALPIC_PROMPT_META_KEY"
+	"ALPIC_INTENT_META_KEY"
 ];
 const environmentVariableSchema = z.object({
 	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"),

package/package.json

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