@alpic-ai/api 0.0.0-staging.gc94c933 → 0.0.0-staging.gccf54e6

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.
Files changed (2) hide show
  1. package/dist/index.mjs +111 -7
  2. package/package.json +1 -1
package/dist/index.mjs CHANGED
@@ -71,7 +71,7 @@ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreen
71
71
  chatgpt: widgetScreenshotSchema.optional(),
72
72
  claudeai: widgetScreenshotSchema.optional()
73
73
  }) });
74
- z.enum([
74
+ const deploymentStatusSchema$1 = z.enum([
75
75
  "ongoing",
76
76
  "deployed",
77
77
  "failed",
@@ -81,6 +81,51 @@ z.object({
81
81
  timestamp: z.coerce.date().optional(),
82
82
  content: z.string().optional()
83
83
  });
84
+ const deploymentSummarySchema = z.object({
85
+ id: z.string(),
86
+ status: deploymentStatusSchema$1,
87
+ sourceBucket: z.string().nullable(),
88
+ sourceObjectKey: z.string().nullable(),
89
+ sourceRef: z.string().nullable(),
90
+ sourceCommitId: z.string().nullable(),
91
+ sourceCommitMessage: z.string().nullable(),
92
+ environmentId: z.string(),
93
+ authorUsername: z.string().nullable(),
94
+ authorAvatarUrl: z.string().nullable(),
95
+ startedAt: z.coerce.date().nullable(),
96
+ completedAt: z.coerce.date().nullable(),
97
+ isCurrent: z.boolean().optional(),
98
+ createdAt: z.coerce.date(),
99
+ updatedAt: z.coerce.date()
100
+ });
101
+ const allowedPlatformSchema = platformSchema;
102
+ const environmentDomainSchema = z.object({
103
+ domain: z.string(),
104
+ status: z.enum([
105
+ "ongoing",
106
+ "deployed",
107
+ "failed"
108
+ ]),
109
+ createdAt: z.coerce.date(),
110
+ updatedAt: z.coerce.date()
111
+ });
112
+ const environmentSchema$1 = z.object({
113
+ id: z.string(),
114
+ name: z.string(),
115
+ sourceBranch: z.string().nullable(),
116
+ mcpServerUrl: z.string(),
117
+ activeDeployment: deploymentSummarySchema.optional(),
118
+ latestDeployment: deploymentSummarySchema.optional(),
119
+ openaiAppsChallenge: z.string().nullable().optional(),
120
+ isPlaygroundEnabled: z.boolean(),
121
+ isIpWhitelistEnabled: z.boolean(),
122
+ ipAllowlist: z.array(z.string()).nullable(),
123
+ allowedPlatforms: z.array(allowedPlatformSchema),
124
+ projectId: z.string(),
125
+ createdAt: z.coerce.date(),
126
+ updatedAt: z.coerce.date()
127
+ });
128
+ const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
84
129
  z.object({
85
130
  id: z.string(),
86
131
  createdAt: z.coerce.date(),
@@ -197,6 +242,60 @@ const transportSchema = z.enum([
197
242
  "sse",
198
243
  "streamablehttp"
199
244
  ]);
245
+ z.object({
246
+ id: z.string(),
247
+ name: z.string(),
248
+ teamId: z.string(),
249
+ sourceRepository: z.string().nullable(),
250
+ createdAt: z.coerce.date().optional(),
251
+ runtime: runtimeSchema,
252
+ transport: transportSchema.nullable(),
253
+ rootDirectory: z.string().nullable(),
254
+ installCommand: z.string().nullable(),
255
+ buildCommand: z.string().nullable(),
256
+ buildOutputDir: z.string().nullable(),
257
+ startCommand: z.string().nullable(),
258
+ fixedOutboundIp: z.boolean(),
259
+ environments: z.array(environmentWithDomainsSchema),
260
+ productionEnvironment: environmentWithDomainsSchema.nullable()
261
+ });
262
+ z.object({
263
+ domain: z.string(),
264
+ createdAt: z.coerce.date(),
265
+ status: z.enum([
266
+ "ongoing",
267
+ "deployed",
268
+ "failed"
269
+ ]),
270
+ environment: environmentSchema$1
271
+ });
272
+ const serverFieldsSchema$1 = z.object({
273
+ $schema: z.string(),
274
+ name: z.string(),
275
+ description: z.string(),
276
+ version: z.string().optional(),
277
+ title: z.string().optional(),
278
+ websiteUrl: z.string().optional(),
279
+ icons: z.array(z.object({
280
+ src: z.string(),
281
+ mimeType: z.string().optional(),
282
+ sizes: z.array(z.string()).optional()
283
+ })).optional(),
284
+ remotes: z.array(z.object({
285
+ type: z.string(),
286
+ url: z.string().optional(),
287
+ headers: z.array(z.object({
288
+ name: z.string(),
289
+ description: z.string(),
290
+ isRequired: z.boolean().optional(),
291
+ isSecret: z.boolean().optional()
292
+ })).optional()
293
+ })).optional()
294
+ }).catchall(z.unknown());
295
+ z.object({
296
+ serverFields: serverFieldsSchema$1,
297
+ source: z.enum(["registry", "defaults"])
298
+ });
200
299
  const toolDefinitionSchema = z.object({
201
300
  name: z.string(),
202
301
  title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
@@ -214,6 +313,10 @@ const positiveTestCaseSchema = z.object({
214
313
  toolTriggered: z.string().optional(),
215
314
  expectedOutput: z.string().optional()
216
315
  }).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
316
+ const screenshotEntrySchema = z.object({
317
+ prompt: z.string(),
318
+ url: z.url()
319
+ }).describe("Each screenshot: the user prompt that produced it + the image URL.");
217
320
  /** Accepts either a valid email or URL. */
218
321
  const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
219
322
  const chatgptCategorySchema = z.enum([
@@ -254,7 +357,7 @@ const chatgptTranslationSchema = z.object({
254
357
  */
255
358
  const chatgptSubmissionFormDataSchema = z.object({
256
359
  logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
257
- logoDark: z.string().describe("Logo icon for dark mode. Square PNG. Same specs as the light icon."),
360
+ logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
258
361
  appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
259
362
  tagline: z.string().max(30).describe("Plain-language phrase focused on function and user value. 30 chars max."),
260
363
  description: z.string().describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
@@ -272,7 +375,7 @@ const chatgptSubmissionFormDataSchema = z.object({
272
375
  toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
273
376
  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."),
274
377
  negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases — prompts where the app should NOT trigger but the model might think it's relevant."),
275
- 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."),
378
+ screenshots: z.array(screenshotEntrySchema).describe("In-app screenshots paired with the user prompt that produced them. Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 4 entries. First three are public. Images: 706px wide, 400–860px tall, PNG."),
276
379
  translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
277
380
  allowedCountries: chatgptAllowedCountriesSchema.describe("'Allow all' or restrict to a specific list. See OpenAI's supported countries list."),
278
381
  releaseNotes: z.string().describe("Publicly displayed on the app details page.")
@@ -452,19 +555,20 @@ Reviewers test every single tool you list here — don't list tools that don't w
452
555
  • 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
453
556
  • 'I've specified accurate tool annotations for all tools' — every tool has the correct annotation: readOnlyHint: true for read operations (search, get, list, fetch), OR destructiveHint: true for write operations (create, update, delete, send).
454
557
  This is the #1 reason submissions get rejected (30% of all rejections). Do not check these boxes without actually having implemented the annotations. See MCP spec for how to add them.`),
455
- logoLight: z.string().describe(`Your connector's logo as displayed in the directory. Requirements:
558
+ logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
456
559
  • Format: SVG only
457
560
  • Aspect ratio: square (1:1)
458
- • Should work on both light and dark backgrounds (or you can provide separate light/dark versions)
561
+ • Should work on a light background
459
562
  • Provide via URL (Google Drive link is fine) or upload directly
460
563
  Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
461
- screenshots: z.array(z.url()).describe(`Screenshots or promotional images of your connector in action within Claude. Strongly recommended for all connectors, and required for MCP Apps (interactive UI). Guidelines:
564
+ logoDark: z.string().optional().describe(`Optional dark-mode variant of the connector logo. Same specs as the light variant (SVG, square 1:1) but designed to read on a dark background. Leave empty if the light logo already works on dark.`),
565
+ screenshots: z.array(screenshotEntrySchema).describe(`Screenshots or promotional images of your connector in action within Claude. Strongly recommended for all connectors, and required for MCP Apps (interactive UI). Guidelines:
462
566
  • 3–5 images is ideal
463
567
  • Minimum 1000px width, PNG format preferred
568
+ • Each screenshot is paired with the user prompt that produced it
464
569
  • Crop to just the relevant part of the Claude interface (the tool response area)
465
570
  • Show your connector doing something impressive and useful — real data, real results
466
571
  • If you're an MCP App, include screenshots of your interactive UI elements
467
- • Videos are also welcome
468
572
  These images appear in your directory listing and are a key factor in driving user installs.`)
469
573
  });
470
574
  claudeSubmissionFormDataSchema.pick({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alpic-ai/api",
3
- "version": "0.0.0-staging.gc94c933",
3
+ "version": "0.0.0-staging.gccf54e6",
4
4
  "description": "Contract for the Alpic API",
5
5
  "type": "module",
6
6
  "main": "./dist/index.mjs",