@alpic-ai/api 0.0.0-dev.gf4f3876 → 0.0.0-dev.gf54e088
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.
- package/dist/index.d.mts +25 -2
- package/dist/index.mjs +274 -241
- package/package.json +23 -7
package/dist/index.d.mts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
2
|
import { InferContractRouterInputs, InferContractRouterOutputs } from "@orpc/contract";
|
|
3
|
-
|
|
4
3
|
//#region src/api.contract.d.ts
|
|
5
4
|
type ApiContext = {
|
|
6
5
|
request: Request & {
|
|
@@ -225,6 +224,17 @@ declare const contract: {
|
|
|
225
224
|
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
226
225
|
environmentId: z.ZodString;
|
|
227
226
|
token: z.ZodOptional<z.ZodString>;
|
|
227
|
+
settings: z.ZodOptional<z.ZodObject<{
|
|
228
|
+
installCommand: z.ZodOptional<z.ZodString>;
|
|
229
|
+
buildCommand: z.ZodOptional<z.ZodString>;
|
|
230
|
+
buildOutputDir: z.ZodOptional<z.ZodString>;
|
|
231
|
+
startCommand: z.ZodOptional<z.ZodString>;
|
|
232
|
+
transport: z.ZodEnum<{
|
|
233
|
+
stdio: "stdio";
|
|
234
|
+
sse: "sse";
|
|
235
|
+
streamablehttp: "streamablehttp";
|
|
236
|
+
}>;
|
|
237
|
+
}, z.core.$strip>>;
|
|
228
238
|
}, z.core.$strip>, z.ZodObject<{
|
|
229
239
|
id: z.ZodString;
|
|
230
240
|
status: z.ZodEnum<{
|
|
@@ -448,6 +458,7 @@ declare const contract: {
|
|
|
448
458
|
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
449
459
|
NOT_FOUND: {};
|
|
450
460
|
BAD_REQUEST: {};
|
|
461
|
+
FORBIDDEN: {};
|
|
451
462
|
}>, Record<never, never>>;
|
|
452
463
|
};
|
|
453
464
|
get: {
|
|
@@ -663,6 +674,7 @@ declare const contract: {
|
|
|
663
674
|
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
664
675
|
NOT_FOUND: {};
|
|
665
676
|
BAD_REQUEST: {};
|
|
677
|
+
FORBIDDEN: {};
|
|
666
678
|
}>, Record<never, never>>;
|
|
667
679
|
};
|
|
668
680
|
delete: {
|
|
@@ -938,6 +950,17 @@ declare const contract: {
|
|
|
938
950
|
type RouterInput = InferContractRouterInputs<typeof contract>;
|
|
939
951
|
type RouterOutput = InferContractRouterOutputs<typeof contract>;
|
|
940
952
|
//#endregion
|
|
953
|
+
//#region src/auth-scope.d.ts
|
|
954
|
+
/** Credential scope required by an API route. */
|
|
955
|
+
type AuthScope = "any" | "user";
|
|
956
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
957
|
+
declare const AUTH_SCOPE_ANY = "any";
|
|
958
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
959
|
+
declare const AUTH_SCOPE_USER = "user";
|
|
960
|
+
type RouteAuthMeta = {
|
|
961
|
+
authScope?: AuthScope;
|
|
962
|
+
};
|
|
963
|
+
//#endregion
|
|
941
964
|
//#region ../domains/src/platforms/schemas.d.ts
|
|
942
965
|
declare const platformSchema: z.ZodEnum<{
|
|
943
966
|
chatgpt: "chatgpt";
|
|
@@ -1017,4 +1040,4 @@ declare const serverFieldsSchema: z.ZodObject<{
|
|
|
1017
1040
|
}, z.core.$strip>>>;
|
|
1018
1041
|
}, z.core.$strip>;
|
|
1019
1042
|
//#endregion
|
|
1020
|
-
export { ApiContext, PLATFORM_LABELS, type Platform, RouterInput, RouterOutput, Runtime, Transport, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
1043
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, ApiContext, AuthScope, PLATFORM_LABELS, type Platform, RouteAuthMeta, RouterInput, RouterOutput, Runtime, Transport, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
package/dist/index.mjs
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
import * as z$1 from "zod/v4";
|
|
3
3
|
import { oc } from "@orpc/contract";
|
|
4
4
|
import ms from "ms";
|
|
5
|
-
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.29.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.29.0_zod@4.4.3/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -169,11 +169,21 @@ z$1.object({
|
|
|
169
169
|
token: z$1.string(),
|
|
170
170
|
token_type_hint: z$1.string().optional()
|
|
171
171
|
}).strip();
|
|
172
|
-
|
|
172
|
+
//#endregion
|
|
173
|
+
//#region ../domains/dist/index.mjs
|
|
174
|
+
const AI_PLATFORMS = ["chatgpt", "claudeai"];
|
|
175
|
+
const platformSchema = z.enum(AI_PLATFORMS);
|
|
173
176
|
const PLATFORM_LABELS = {
|
|
174
177
|
chatgpt: "ChatGPT",
|
|
175
178
|
claudeai: "Claude.ai"
|
|
176
179
|
};
|
|
180
|
+
const WAF_PLATFORMS = [
|
|
181
|
+
"akamai",
|
|
182
|
+
"cloudflare",
|
|
183
|
+
"fastly"
|
|
184
|
+
];
|
|
185
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
186
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
177
187
|
const auditStatusSchema = z.enum([
|
|
178
188
|
"pending",
|
|
179
189
|
"partial",
|
|
@@ -276,11 +286,11 @@ const deploymentSummarySchema = z.object({
|
|
|
276
286
|
/**
|
|
277
287
|
* Public environment
|
|
278
288
|
*
|
|
279
|
-
*
|
|
289
|
+
* Answers anonymously and exposes no OAuth metadata.
|
|
280
290
|
*/
|
|
281
291
|
const publicEnvironmentSchema = z.object({
|
|
282
|
-
|
|
283
|
-
oAuthMetadata: z.
|
|
292
|
+
allowsAnonymous: z.literal(true),
|
|
293
|
+
oAuthMetadata: z.strictObject({})
|
|
284
294
|
});
|
|
285
295
|
/**
|
|
286
296
|
* Protected environment with an external resource metadata URL
|
|
@@ -289,7 +299,7 @@ const publicEnvironmentSchema = z.object({
|
|
|
289
299
|
* Everything that follows is handled outside of the MCP server scope.
|
|
290
300
|
*/
|
|
291
301
|
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
292
|
-
|
|
302
|
+
allowsAnonymous: z.boolean(),
|
|
293
303
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
304
|
scope: z.string().optional()
|
|
295
305
|
});
|
|
@@ -301,7 +311,7 @@ const externalResourceMetadataEnvironmentSchema = z.object({
|
|
|
301
311
|
* Everything that follows is handled outside of the MCP server scope.
|
|
302
312
|
*/
|
|
303
313
|
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
|
-
|
|
314
|
+
allowsAnonymous: z.boolean(),
|
|
305
315
|
oAuthMetadata: z.object({
|
|
306
316
|
externalAuthorizationServerUrl: z.url(),
|
|
307
317
|
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
@@ -315,7 +325,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
315
325
|
* The server itself exposes the /.well-known/oauth-authorization-server endpoint.
|
|
316
326
|
*/
|
|
317
327
|
const standaloneEnvironmentSchema = z.object({
|
|
318
|
-
|
|
328
|
+
allowsAnonymous: z.boolean(),
|
|
319
329
|
oAuthMetadata: z.object({
|
|
320
330
|
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
321
331
|
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
@@ -330,6 +340,36 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
330
340
|
* are advertised. Clients must obtain credentials out-of-band.
|
|
331
341
|
*/
|
|
332
342
|
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
343
|
+
allowsAnonymous: z.literal(false),
|
|
344
|
+
oAuthMetadata: z.strictObject({}),
|
|
345
|
+
scope: z.string().optional()
|
|
346
|
+
});
|
|
347
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
348
|
+
isPublic: z.literal(true),
|
|
349
|
+
oAuthMetadata: z.undefined().optional()
|
|
350
|
+
});
|
|
351
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
352
|
+
isPublic: z.literal(false),
|
|
353
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
354
|
+
scope: z.string().optional()
|
|
355
|
+
});
|
|
356
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
357
|
+
isPublic: z.literal(false),
|
|
358
|
+
oAuthMetadata: z.object({
|
|
359
|
+
externalAuthorizationServerUrl: z.url(),
|
|
360
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
361
|
+
}),
|
|
362
|
+
scope: z.string().optional()
|
|
363
|
+
});
|
|
364
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
365
|
+
isPublic: z.literal(false),
|
|
366
|
+
oAuthMetadata: z.object({
|
|
367
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
368
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
369
|
+
}),
|
|
370
|
+
scope: z.string().optional()
|
|
371
|
+
});
|
|
372
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
373
|
isPublic: z.literal(false),
|
|
334
374
|
oAuthMetadata: z.strictObject({}),
|
|
335
375
|
scope: z.string().optional()
|
|
@@ -339,11 +379,21 @@ z.union([
|
|
|
339
379
|
externalResourceMetadataEnvironmentSchema,
|
|
340
380
|
externalAuthorizationServerEnvironmentSchema,
|
|
341
381
|
standaloneEnvironmentSchema,
|
|
342
|
-
protectedWithoutDiscoveryEnvironmentSchema
|
|
382
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
383
|
+
legacyPublicEnvironmentSchema,
|
|
384
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
385
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
386
|
+
legacyStandaloneEnvironmentSchema,
|
|
387
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
388
|
+
]);
|
|
389
|
+
const playgroundModelSchema = z.enum([
|
|
390
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
391
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
392
|
+
"openai.gpt-5.4",
|
|
393
|
+
"openai.gpt-5.5"
|
|
343
394
|
]);
|
|
344
|
-
const allowedPlatformSchema = platformSchema;
|
|
345
395
|
const environmentDomainSchema = z.object({
|
|
346
|
-
|
|
396
|
+
name: z.string(),
|
|
347
397
|
status: z.enum([
|
|
348
398
|
"ongoing",
|
|
349
399
|
"deployed",
|
|
@@ -361,6 +411,7 @@ const environmentSchema$1 = z.object({
|
|
|
361
411
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
362
412
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
363
413
|
isPlaygroundEnabled: z.boolean(),
|
|
414
|
+
playgroundModel: playgroundModelSchema,
|
|
364
415
|
isIpWhitelistEnabled: z.boolean(),
|
|
365
416
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
366
417
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -369,6 +420,14 @@ const environmentSchema$1 = z.object({
|
|
|
369
420
|
updatedAt: z.coerce.date()
|
|
370
421
|
});
|
|
371
422
|
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
423
|
+
z.object({
|
|
424
|
+
sessionReplayEnabled: z.boolean(),
|
|
425
|
+
collectRequestPayload: z.boolean(),
|
|
426
|
+
collectResponsePayload: z.boolean(),
|
|
427
|
+
collectErrorMessage: z.boolean(),
|
|
428
|
+
collectUserData: z.boolean(),
|
|
429
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
430
|
+
});
|
|
372
431
|
z.object({
|
|
373
432
|
id: z.string(),
|
|
374
433
|
createdAt: z.coerce.date(),
|
|
@@ -502,15 +561,27 @@ z.object({
|
|
|
502
561
|
environments: z.array(environmentWithDomainsSchema),
|
|
503
562
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
504
563
|
});
|
|
564
|
+
const domainFailureReasonSchema = z.enum([
|
|
565
|
+
"caa",
|
|
566
|
+
"dns",
|
|
567
|
+
"invalid_domain",
|
|
568
|
+
"other"
|
|
569
|
+
]);
|
|
570
|
+
const projectDomainMappingSchema = z.object({
|
|
571
|
+
pathPrefix: z.string(),
|
|
572
|
+
environment: environmentSchema$1
|
|
573
|
+
});
|
|
505
574
|
z.object({
|
|
506
|
-
|
|
575
|
+
name: z.string(),
|
|
507
576
|
createdAt: z.coerce.date(),
|
|
508
577
|
status: z.enum([
|
|
509
578
|
"ongoing",
|
|
510
579
|
"deployed",
|
|
511
580
|
"failed"
|
|
512
581
|
]),
|
|
513
|
-
|
|
582
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
583
|
+
environment: environmentSchema$1,
|
|
584
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
514
585
|
});
|
|
515
586
|
const serverFieldsSchema$1 = z.object({
|
|
516
587
|
$schema: z.string(),
|
|
@@ -574,10 +645,13 @@ const positiveTestCaseSchema = z.object({
|
|
|
574
645
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
575
646
|
const screenshotEntrySchema = z.object({
|
|
576
647
|
prompt: z.string(),
|
|
577
|
-
url: z.url()
|
|
648
|
+
url: z.url()
|
|
578
649
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
650
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
579
651
|
/** Accepts either a valid email or URL. */
|
|
580
652
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
653
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
654
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
581
655
|
const chatgptCategorySchema = z.enum([
|
|
582
656
|
"BUSINESS",
|
|
583
657
|
"COLLABORATION",
|
|
@@ -915,23 +989,34 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
915
989
|
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the app does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
|
|
916
990
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
917
991
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
918
|
-
companyUrl:
|
|
992
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
919
993
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
920
|
-
privacyPolicyUrl:
|
|
921
|
-
termsOfServiceUrl:
|
|
922
|
-
demoRecordingUrl:
|
|
994
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
995
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
996
|
+
demoRecordingUrl: urlField.describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
923
997
|
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."),
|
|
924
|
-
serverUrl:
|
|
998
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
925
999
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
926
1000
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
927
1001
|
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
|
|
928
1002
|
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Collectively cover the full capability across different flow stages (initial search or browse, market or locale handling, post-interaction detail, an action ChatGPT performs on the user's behalf, and a conversion or secondary tool) rather than five variations of the same first step."),
|
|
929
1003
|
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
930
|
-
screenshots: z.array(screenshotEntrySchema).max(3).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 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
1004
|
+
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
931
1005
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
932
1006
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
933
1007
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
934
1008
|
});
|
|
1009
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1010
|
+
tagline: z.string().optional(),
|
|
1011
|
+
companyUrl: z.string().optional(),
|
|
1012
|
+
supportChannel: z.string().optional(),
|
|
1013
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1014
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1015
|
+
demoRecordingUrl: z.string().optional(),
|
|
1016
|
+
serverUrl: z.string().optional(),
|
|
1017
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1018
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1019
|
+
});
|
|
935
1020
|
chatgptSubmissionFormDataSchema.pick({
|
|
936
1021
|
appName: true,
|
|
937
1022
|
developerName: true,
|
|
@@ -948,7 +1033,7 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
948
1033
|
toolJustifications: true
|
|
949
1034
|
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
950
1035
|
const claudeCategorySchema = z.enum([
|
|
951
|
-
"
|
|
1036
|
+
"Productivity",
|
|
952
1037
|
"Communication",
|
|
953
1038
|
"Data & Analytics",
|
|
954
1039
|
"Development tools",
|
|
@@ -956,205 +1041,154 @@ const claudeCategorySchema = z.enum([
|
|
|
956
1041
|
"Consumer Health",
|
|
957
1042
|
"Health & Life Sciences",
|
|
958
1043
|
"Media & Entertainment",
|
|
959
|
-
"Commerce & Shopping"
|
|
1044
|
+
"Commerce & Shopping",
|
|
1045
|
+
"Legal",
|
|
1046
|
+
"Sales and marketing",
|
|
1047
|
+
"Creative",
|
|
1048
|
+
"Nonprofit",
|
|
1049
|
+
"Education",
|
|
1050
|
+
"Other"
|
|
960
1051
|
]);
|
|
961
|
-
const
|
|
962
|
-
"No auth needed",
|
|
963
|
-
"OAuth 2.0",
|
|
964
|
-
"Custom URL"
|
|
965
|
-
]);
|
|
966
|
-
const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
|
|
967
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1052
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
968
1053
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
969
|
-
"
|
|
970
|
-
"
|
|
971
|
-
"
|
|
972
|
-
]);
|
|
973
|
-
const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
|
|
974
|
-
const claudeTestedSurfaceSchema = z.enum([
|
|
975
|
-
"Claude.ai (web)",
|
|
976
|
-
"Claude Desktop",
|
|
977
|
-
"Claude Code",
|
|
978
|
-
"Cowork"
|
|
1054
|
+
"read_only",
|
|
1055
|
+
"write_only",
|
|
1056
|
+
"read_write"
|
|
979
1057
|
]);
|
|
980
|
-
const
|
|
981
|
-
"
|
|
982
|
-
"
|
|
983
|
-
"
|
|
984
|
-
"
|
|
985
|
-
"
|
|
1058
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1059
|
+
"oauth_dcr",
|
|
1060
|
+
"oauth_cimd",
|
|
1061
|
+
"oauth_anthropic_creds",
|
|
1062
|
+
"custom_connection",
|
|
1063
|
+
"none"
|
|
986
1064
|
]);
|
|
987
|
-
const
|
|
988
|
-
"
|
|
989
|
-
"
|
|
990
|
-
"
|
|
991
|
-
"GDPR compliant (if applicable)"
|
|
1065
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1066
|
+
"first_party",
|
|
1067
|
+
"proxied",
|
|
1068
|
+
"third_party"
|
|
992
1069
|
]);
|
|
993
|
-
const
|
|
994
|
-
|
|
995
|
-
"
|
|
996
|
-
"
|
|
1070
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1071
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1072
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1073
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1074
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1075
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1076
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1077
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1078
|
+
"Public documentation for this connector will be live by the publish date."
|
|
997
1079
|
]);
|
|
998
1080
|
/**
|
|
999
|
-
* Field order mirrors the
|
|
1000
|
-
*
|
|
1081
|
+
* Field order mirrors the claude.ai directory submission wizard
|
|
1082
|
+
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1083
|
+
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1001
1084
|
*/
|
|
1002
1085
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
(
|
|
1013
|
-
|
|
1014
|
-
(
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
•
|
|
1032
|
-
•
|
|
1033
|
-
•
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
• '
|
|
1049
|
-
• '
|
|
1050
|
-
• '
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
|
|
1078
|
-
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
1079
|
-
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
1080
|
-
• 'SSE (Server-Sent Events)' — the older transport. SSE may be deprecated by Anthropic later in 2025/2026. If you currently only support SSE, you should plan to migrate to Streamable HTTP.
|
|
1081
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
1082
|
-
serverDocumentationLink: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. This is displayed in the Directory listing and must be publicly accessible without login. Minimum requirements for the docs page:
|
|
1083
|
-
• What the connector does and its key capabilities
|
|
1084
|
-
• How to connect/set it up (step by step)
|
|
1085
|
-
• What each tool does (or at least the main ones)
|
|
1086
|
-
• How to troubleshoot common issues
|
|
1087
|
-
• A support contact or channel
|
|
1088
|
-
Acceptable formats: a dedicated docs page, a help center article, a README on GitHub, or a blog post — as long as it's comprehensive. Note: Anthropic requires public documentation to be live by your publish date.`),
|
|
1089
|
-
privacyPolicyUrl: z.url().describe(`URL to your privacy policy. This is mandatory and displayed in the directory listing. Missing or incomplete privacy policies result in immediate rejection. Your privacy policy must cover:
|
|
1090
|
-
• What data you collect (and how)
|
|
1091
|
-
• How you use the collected data
|
|
1092
|
-
• Where and how long you store it
|
|
1093
|
-
• Whether you share data with third parties (and who)
|
|
1094
|
-
• How users can contact you about data concerns
|
|
1095
|
-
The policy must be publicly accessible. If you don't have one yet, create one before submitting — there are free generators online, but make sure it accurately reflects your actual practices. If you're GDPR-compliant, your policy should reflect that.`),
|
|
1096
|
-
supportChannel: supportChannelSchema.describe(`A URL or email address where users can get help with your connector. This is displayed in the Directory listing. Acceptable options:
|
|
1097
|
-
• Email address (e.g. support@myapp.com)
|
|
1098
|
-
• Link to a GitHub Issues page
|
|
1099
|
-
• Link to a help center or support article
|
|
1100
|
-
• Link to a Discord/Slack community
|
|
1101
|
-
• Link to your documentation's troubleshooting section
|
|
1102
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1103
|
-
testingCredentials: z.string().describe(`Provide login credentials for a test account that Anthropic reviewers can use to verify your server works end-to-end. Critical requirements:
|
|
1104
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
1105
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
1106
|
-
• If your service uses Google OAuth or another OAuth that requires email verification, use mcp-review@anthropic.com as the account email — Anthropic has access to this inbox.
|
|
1107
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
1108
|
-
• If your service requires API keys instead of a password, provide those.
|
|
1109
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
1110
|
-
tools: z.array(toolDefinitionSchema).describe(`A comma-separated list of all tools your MCP server exposes. Use the format: tool_name (Human-Readable Name). The tool_name is the internal identifier (snake_case, max 64 characters). The Human-Readable Name is what users see.
|
|
1111
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
1112
|
-
Reviewers test every single tool you list here — don't list tools that don't work. Also: do not have a single catch-all tool like api_request(method, endpoint) — Anthropic rejects these. Each action should be its own purpose-built tool.`),
|
|
1113
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
1114
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
1115
|
-
• '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).
|
|
1116
|
-
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.`),
|
|
1117
|
-
testedSurfaces: z.array(claudeTestedSurfaceSchema).describe(`Confirm testing is complete and your server works as intended in these surfaces. Select every surface you've verified. Claude.ai (web) and Claude Desktop are the usual targets for remote MCP servers; Claude Code and Cowork compatibility is not required. Anthropic requires at least two surfaces.`),
|
|
1118
|
-
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
1119
|
-
• Format: SVG only
|
|
1120
|
-
• Aspect ratio: square (1:1)
|
|
1121
|
-
• Should work on a light background
|
|
1122
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
1123
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
1124
|
-
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.`),
|
|
1125
|
-
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:
|
|
1126
|
-
• 3–5 images is ideal
|
|
1127
|
-
• Minimum 1000px width, PNG format preferred
|
|
1128
|
-
• Each screenshot is paired with the user prompt that produced it
|
|
1129
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
1130
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
1131
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
1132
|
-
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
1086
|
+
serverUrl: z.url().describe(`The full https:// URL where your MCP server is hosted and reachable. In the claude.ai wizard this is read live
|
|
1087
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1088
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1089
|
+
name: z.string().max(100).describe(`The public display name for your connector as it appears in the directory. Use your brand/product name. You must
|
|
1090
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1091
|
+
slug: z.string().max(50).regex(/^[a-z0-9-]+$/).describe(`URL-safe identifier for your connector's directory page. Lowercase letters, numbers, and hyphens only.
|
|
1092
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1093
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1094
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1095
|
+
description: z.string().max(2e3).describe(`A description of what your connector does and its key features, shown on the connector's detail page in
|
|
1096
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1097
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1098
|
+
iconUrl: z.url().optional().describe(`Optional custom icon for the directory listing — a square SVG. By default the favicon from your MCP URL is used
|
|
1099
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1100
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1101
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1102
|
+
by your publish date.`),
|
|
1103
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1104
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1105
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1106
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1107
|
+
screenshots: z.array(screenshotEntrySchema).optional().describe(`Carousel images shown on your connector's directory page (PNG). Each is paired with the user prompt that produced
|
|
1108
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1109
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1110
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1111
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1112
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1113
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1114
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1115
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1116
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1117
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1118
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1119
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1120
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1121
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1122
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1123
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1124
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1125
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1126
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1127
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1128
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1129
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1130
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1131
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1132
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1133
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1134
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1135
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1136
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1137
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1138
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1139
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1140
|
+
fully populated account.`),
|
|
1141
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1142
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1143
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1144
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1145
|
+
});
|
|
1146
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1147
|
+
serverUrl: z.string().optional(),
|
|
1148
|
+
name: z.string().optional(),
|
|
1149
|
+
slug: z.string().optional(),
|
|
1150
|
+
oneLiner: z.string().optional(),
|
|
1151
|
+
description: z.string().optional(),
|
|
1152
|
+
iconUrl: z.string().optional(),
|
|
1153
|
+
documentation: z.string().optional(),
|
|
1154
|
+
support: z.string().optional(),
|
|
1155
|
+
privacyPolicy: z.string().optional(),
|
|
1156
|
+
companyWebsite: z.string().optional(),
|
|
1157
|
+
primaryContactEmail: z.string().optional(),
|
|
1158
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1159
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1133
1160
|
});
|
|
1134
1161
|
claudeSubmissionFormDataSchema.pick({
|
|
1135
|
-
companyName: true,
|
|
1136
|
-
appName: true,
|
|
1137
|
-
mcpUrlType: true,
|
|
1138
1162
|
serverUrl: true,
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
transportSupport: true,
|
|
1163
|
+
name: true,
|
|
1164
|
+
slug: true,
|
|
1165
|
+
companyName: true,
|
|
1143
1166
|
primaryContactEmail: true,
|
|
1144
1167
|
primaryContactName: true,
|
|
1168
|
+
readWriteCapabilities: true,
|
|
1145
1169
|
authentication: true,
|
|
1146
|
-
|
|
1147
|
-
|
|
1170
|
+
apiOwnership: true,
|
|
1171
|
+
personalHealthData: true
|
|
1148
1172
|
}).extend({
|
|
1149
1173
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1150
|
-
|
|
1174
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1175
|
+
});
|
|
1176
|
+
/**
|
|
1177
|
+
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1178
|
+
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1179
|
+
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1180
|
+
* colocated with the Claude contract.
|
|
1181
|
+
*/
|
|
1182
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1183
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1184
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1185
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1186
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1187
|
+
});
|
|
1188
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1189
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1190
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1151
1191
|
});
|
|
1152
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1153
|
-
tagline: true,
|
|
1154
|
-
description: true,
|
|
1155
|
-
category: true,
|
|
1156
|
-
testCases: true
|
|
1157
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
1158
1192
|
const submissionMetaFieldsSchema = z.object({
|
|
1159
1193
|
id: z.string(),
|
|
1160
1194
|
environmentId: z.string(),
|
|
@@ -1164,14 +1198,14 @@ const submissionMetaFieldsSchema = z.object({
|
|
|
1164
1198
|
});
|
|
1165
1199
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1166
1200
|
platform: z.literal("claudeai"),
|
|
1167
|
-
formData:
|
|
1201
|
+
formData: claudeSubmissionDraftSchema
|
|
1168
1202
|
});
|
|
1169
1203
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1170
1204
|
platform: z.literal("chatgpt"),
|
|
1171
|
-
formData:
|
|
1205
|
+
formData: chatgptSubmissionDraftSchema
|
|
1172
1206
|
});
|
|
1173
1207
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1174
|
-
z.union([
|
|
1208
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1175
1209
|
const subscriptionPlanSchema = z.enum([
|
|
1176
1210
|
"pro",
|
|
1177
1211
|
"business",
|
|
@@ -1195,6 +1229,12 @@ z.object({
|
|
|
1195
1229
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1196
1230
|
});
|
|
1197
1231
|
//#endregion
|
|
1232
|
+
//#region src/auth-scope.ts
|
|
1233
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1234
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1235
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1236
|
+
const AUTH_SCOPE_USER = "user";
|
|
1237
|
+
//#endregion
|
|
1198
1238
|
//#region src/schemas.ts
|
|
1199
1239
|
const RESERVED_KEYS = [
|
|
1200
1240
|
"_HANDLER",
|
|
@@ -1230,7 +1270,10 @@ const RESERVED_KEYS = [
|
|
|
1230
1270
|
"BUILD_ARG_START_COMMAND",
|
|
1231
1271
|
"ALPIC_HOST",
|
|
1232
1272
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1233
|
-
"ALPIC_INTENT_META_KEY"
|
|
1273
|
+
"ALPIC_INTENT_META_KEY",
|
|
1274
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1275
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1276
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1234
1277
|
];
|
|
1235
1278
|
const environmentVariableSchema = z.object({
|
|
1236
1279
|
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"),
|
|
@@ -1423,7 +1466,8 @@ const createProjectContractV1 = oc.route({
|
|
|
1423
1466
|
successDescription: "The project has been created successfully"
|
|
1424
1467
|
}).errors({
|
|
1425
1468
|
NOT_FOUND: {},
|
|
1426
|
-
BAD_REQUEST: {}
|
|
1469
|
+
BAD_REQUEST: {},
|
|
1470
|
+
FORBIDDEN: {}
|
|
1427
1471
|
}).input(z.object({
|
|
1428
1472
|
teamId: z.string().optional(),
|
|
1429
1473
|
name: z.string().trim().min(1).max(100),
|
|
@@ -1529,7 +1573,8 @@ const updateProjectContractV1 = oc.route({
|
|
|
1529
1573
|
successDescription: "The project has been updated successfully"
|
|
1530
1574
|
}).errors({
|
|
1531
1575
|
NOT_FOUND: {},
|
|
1532
|
-
BAD_REQUEST: {}
|
|
1576
|
+
BAD_REQUEST: {},
|
|
1577
|
+
FORBIDDEN: {}
|
|
1533
1578
|
}).input(z.object({
|
|
1534
1579
|
projectId: z.string().describe("The ID of the project"),
|
|
1535
1580
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
@@ -1547,7 +1592,8 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1547
1592
|
BAD_REQUEST: {}
|
|
1548
1593
|
}).input(z.object({
|
|
1549
1594
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1550
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1595
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1596
|
+
settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
|
|
1551
1597
|
})).output(deploymentSchema);
|
|
1552
1598
|
const uploadDeploymentArtifactContractV1 = oc.route({
|
|
1553
1599
|
path: "/v1/deployments/upload",
|
|
@@ -1584,6 +1630,21 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1584
1630
|
tags: ["deployments"],
|
|
1585
1631
|
successDescription: "The deployment details"
|
|
1586
1632
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1633
|
+
const logEntrySchema = z.object({
|
|
1634
|
+
timestamp: z.coerce.date(),
|
|
1635
|
+
type: z.enum([
|
|
1636
|
+
"START",
|
|
1637
|
+
"END",
|
|
1638
|
+
"INFO",
|
|
1639
|
+
"ERROR",
|
|
1640
|
+
"WARNING",
|
|
1641
|
+
"DEBUG"
|
|
1642
|
+
]),
|
|
1643
|
+
requestId: z.string(),
|
|
1644
|
+
content: z.string().optional(),
|
|
1645
|
+
method: z.string().optional(),
|
|
1646
|
+
durationInMs: z.number().optional()
|
|
1647
|
+
});
|
|
1587
1648
|
const getLogsContractV1 = oc.route({
|
|
1588
1649
|
path: "/v1/environments/{environmentId}/logs",
|
|
1589
1650
|
method: "GET",
|
|
@@ -1608,21 +1669,7 @@ const getLogsContractV1 = oc.route({
|
|
|
1608
1669
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1609
1670
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1610
1671
|
})).output(z.object({
|
|
1611
|
-
logs: z.array(
|
|
1612
|
-
timestamp: z.coerce.date(),
|
|
1613
|
-
type: z.enum([
|
|
1614
|
-
"START",
|
|
1615
|
-
"END",
|
|
1616
|
-
"INFO",
|
|
1617
|
-
"ERROR",
|
|
1618
|
-
"WARNING",
|
|
1619
|
-
"DEBUG"
|
|
1620
|
-
]),
|
|
1621
|
-
requestId: z.string(),
|
|
1622
|
-
content: z.string().optional(),
|
|
1623
|
-
method: z.string().optional(),
|
|
1624
|
-
durationInMs: z.number().optional()
|
|
1625
|
-
})),
|
|
1672
|
+
logs: z.array(logEntrySchema),
|
|
1626
1673
|
nextToken: z.string().nullable()
|
|
1627
1674
|
}));
|
|
1628
1675
|
const getLatestLogsContractV1 = oc.route({
|
|
@@ -1645,21 +1692,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1645
1692
|
"DEBUG"
|
|
1646
1693
|
])).optional().describe("Filter by log level"),
|
|
1647
1694
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1648
|
-
})).output(z.object({ logs: z.array(
|
|
1649
|
-
timestamp: z.coerce.date(),
|
|
1650
|
-
type: z.enum([
|
|
1651
|
-
"START",
|
|
1652
|
-
"END",
|
|
1653
|
-
"INFO",
|
|
1654
|
-
"ERROR",
|
|
1655
|
-
"WARNING",
|
|
1656
|
-
"DEBUG"
|
|
1657
|
-
]),
|
|
1658
|
-
requestId: z.string(),
|
|
1659
|
-
content: z.string().optional(),
|
|
1660
|
-
method: z.string().optional(),
|
|
1661
|
-
durationInMs: z.number().optional()
|
|
1662
|
-
})) }));
|
|
1695
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1663
1696
|
const getDeploymentLogsContractV1 = oc.route({
|
|
1664
1697
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1665
1698
|
method: "GET",
|
|
@@ -1732,7 +1765,7 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1732
1765
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1733
1766
|
tags: ["tunnels"],
|
|
1734
1767
|
successDescription: "The tunnel ticket"
|
|
1735
|
-
}).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1768
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1736
1769
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1737
1770
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1738
1771
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
@@ -1886,4 +1919,4 @@ const contract = {
|
|
|
1886
1919
|
}
|
|
1887
1920
|
};
|
|
1888
1921
|
//#endregion
|
|
1889
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
1922
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@alpic-ai/api",
|
|
3
|
-
"version": "0.0.0-dev.
|
|
3
|
+
"version": "0.0.0-dev.gf54e088",
|
|
4
4
|
"description": "Contract for the Alpic API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.mjs",
|
|
@@ -14,22 +14,38 @@
|
|
|
14
14
|
"files": [
|
|
15
15
|
"dist"
|
|
16
16
|
],
|
|
17
|
+
"nx": {
|
|
18
|
+
"targets": {
|
|
19
|
+
"build": {
|
|
20
|
+
"cache": true,
|
|
21
|
+
"inputs": [
|
|
22
|
+
"{projectRoot}/src/**/*",
|
|
23
|
+
"{projectRoot}/tsdown.config.ts",
|
|
24
|
+
"{projectRoot}/tsconfig.json",
|
|
25
|
+
"^default"
|
|
26
|
+
],
|
|
27
|
+
"outputs": [
|
|
28
|
+
"{projectRoot}/dist"
|
|
29
|
+
]
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
},
|
|
17
33
|
"author": "Alpic",
|
|
18
34
|
"license": "ISC",
|
|
19
35
|
"dependencies": {
|
|
20
|
-
"@orpc/contract": "^1.14.
|
|
36
|
+
"@orpc/contract": "^1.14.8",
|
|
21
37
|
"ms": "^2.1.3",
|
|
22
38
|
"zod": "^4.4.3"
|
|
23
39
|
},
|
|
24
40
|
"devDependencies": {
|
|
25
|
-
"@orpc/openapi": "^1.14.
|
|
26
|
-
"@orpc/zod": "^1.14.
|
|
41
|
+
"@orpc/openapi": "^1.14.8",
|
|
42
|
+
"@orpc/zod": "^1.14.8",
|
|
27
43
|
"@total-typescript/tsconfig": "^1.0.4",
|
|
28
44
|
"@types/ms": "^2.1.0",
|
|
29
45
|
"shx": "^0.4.0",
|
|
30
|
-
"tsdown": "^0.22.
|
|
46
|
+
"tsdown": "^0.22.9",
|
|
31
47
|
"typescript": "^6.0.3",
|
|
32
|
-
"vitest": "^4.1.
|
|
48
|
+
"vitest": "^4.1.10",
|
|
33
49
|
"@alpic-ai/domains": "0.0.0"
|
|
34
50
|
},
|
|
35
51
|
"scripts": {
|
|
@@ -38,7 +54,7 @@
|
|
|
38
54
|
"test": "pnpm run test:unit && pnpm run test:type && pnpm run test:format",
|
|
39
55
|
"test:unit": "vitest run",
|
|
40
56
|
"test:format": "biome check --error-on-warnings .",
|
|
41
|
-
"test:type": "
|
|
57
|
+
"test:type": "tsgo --noEmit",
|
|
42
58
|
"publish:npm": "pnpm publish --tag \"${NPM_TAG}\" --access public --no-git-checks"
|
|
43
59
|
}
|
|
44
60
|
}
|