@alpic-ai/api 0.0.0-staging.f2b9397 → 0.0.0-staging.f31741c

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 CHANGED
@@ -1,6 +1,6 @@
1
+ import { z } from "zod";
1
2
  import * as _$_orpc_contract0 from "@orpc/contract";
2
3
  import { InferContractRouterInputs, InferContractRouterOutputs } from "@orpc/contract";
3
- import { z } from "zod";
4
4
 
5
5
  //#region src/api.contract.d.ts
6
6
  type ApiContext = {
@@ -11,9 +11,9 @@ type ApiContext = {
11
11
  };
12
12
  };
13
13
  declare const deploymentStatusSchema: z.ZodEnum<{
14
- failed: "failed";
15
14
  ongoing: "ongoing";
16
15
  deployed: "deployed";
16
+ failed: "failed";
17
17
  canceled: "canceled";
18
18
  }>;
19
19
  declare const createEnvironmentContractV1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
@@ -103,18 +103,18 @@ declare const contract: {
103
103
  v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
104
104
  projectId: z.ZodString;
105
105
  status: z.ZodOptional<z.ZodArray<z.ZodEnum<{
106
- failed: "failed";
107
106
  ongoing: "ongoing";
108
107
  deployed: "deployed";
108
+ failed: "failed";
109
109
  canceled: "canceled";
110
110
  }>>>;
111
111
  environmentId: z.ZodOptional<z.ZodString>;
112
112
  }, z.core.$strip>, z.ZodArray<z.ZodObject<{
113
113
  id: z.ZodString;
114
114
  status: z.ZodEnum<{
115
- failed: "failed";
116
115
  ongoing: "ongoing";
117
116
  deployed: "deployed";
117
+ failed: "failed";
118
118
  canceled: "canceled";
119
119
  }>;
120
120
  sourceRef: z.ZodNullable<z.ZodString>;
@@ -138,9 +138,9 @@ declare const contract: {
138
138
  }, z.core.$strip>, z.ZodObject<{
139
139
  id: z.ZodString;
140
140
  status: z.ZodEnum<{
141
- failed: "failed";
142
141
  ongoing: "ongoing";
143
142
  deployed: "deployed";
143
+ failed: "failed";
144
144
  canceled: "canceled";
145
145
  }>;
146
146
  sourceRef: z.ZodNullable<z.ZodString>;
@@ -226,9 +226,9 @@ declare const contract: {
226
226
  }, z.core.$strip>, z.ZodObject<{
227
227
  id: z.ZodString;
228
228
  status: z.ZodEnum<{
229
- failed: "failed";
230
229
  ongoing: "ongoing";
231
230
  deployed: "deployed";
231
+ failed: "failed";
232
232
  canceled: "canceled";
233
233
  }>;
234
234
  sourceRef: z.ZodNullable<z.ZodString>;
@@ -403,18 +403,18 @@ declare const contract: {
403
403
  domains: z.ZodArray<z.ZodObject<{
404
404
  domain: z.ZodString;
405
405
  status: z.ZodEnum<{
406
- failed: "failed";
407
406
  ongoing: "ongoing";
408
407
  deployed: "deployed";
408
+ failed: "failed";
409
409
  }>;
410
410
  createdAt: z.ZodCoercedDate<unknown>;
411
411
  }, z.core.$strip>>;
412
412
  latestDeployment: z.ZodNullable<z.ZodObject<{
413
413
  id: z.ZodString;
414
414
  status: z.ZodEnum<{
415
- failed: "failed";
416
415
  ongoing: "ongoing";
417
416
  deployed: "deployed";
417
+ failed: "failed";
418
418
  canceled: "canceled";
419
419
  }>;
420
420
  sourceCommitId: z.ZodNullable<z.ZodString>;
@@ -432,9 +432,9 @@ declare const contract: {
432
432
  latestDeployment: z.ZodNullable<z.ZodObject<{
433
433
  id: z.ZodString;
434
434
  status: z.ZodEnum<{
435
- failed: "failed";
436
435
  ongoing: "ongoing";
437
436
  deployed: "deployed";
437
+ failed: "failed";
438
438
  canceled: "canceled";
439
439
  }>;
440
440
  sourceCommitId: z.ZodNullable<z.ZodString>;
@@ -479,18 +479,18 @@ declare const contract: {
479
479
  domains: z.ZodArray<z.ZodObject<{
480
480
  domain: z.ZodString;
481
481
  status: z.ZodEnum<{
482
- failed: "failed";
483
482
  ongoing: "ongoing";
484
483
  deployed: "deployed";
484
+ failed: "failed";
485
485
  }>;
486
486
  createdAt: z.ZodCoercedDate<unknown>;
487
487
  }, z.core.$strip>>;
488
488
  latestDeployment: z.ZodNullable<z.ZodObject<{
489
489
  id: z.ZodString;
490
490
  status: z.ZodEnum<{
491
- failed: "failed";
492
491
  ongoing: "ongoing";
493
492
  deployed: "deployed";
493
+ failed: "failed";
494
494
  canceled: "canceled";
495
495
  }>;
496
496
  sourceCommitId: z.ZodNullable<z.ZodString>;
@@ -508,9 +508,9 @@ declare const contract: {
508
508
  latestDeployment: z.ZodNullable<z.ZodObject<{
509
509
  id: z.ZodString;
510
510
  status: z.ZodEnum<{
511
- failed: "failed";
512
511
  ongoing: "ongoing";
513
512
  deployed: "deployed";
513
+ failed: "failed";
514
514
  canceled: "canceled";
515
515
  }>;
516
516
  sourceCommitId: z.ZodNullable<z.ZodString>;
@@ -554,18 +554,18 @@ declare const contract: {
554
554
  domains: z.ZodArray<z.ZodObject<{
555
555
  domain: z.ZodString;
556
556
  status: z.ZodEnum<{
557
- failed: "failed";
558
557
  ongoing: "ongoing";
559
558
  deployed: "deployed";
559
+ failed: "failed";
560
560
  }>;
561
561
  createdAt: z.ZodCoercedDate<unknown>;
562
562
  }, z.core.$strip>>;
563
563
  latestDeployment: z.ZodNullable<z.ZodObject<{
564
564
  id: z.ZodString;
565
565
  status: z.ZodEnum<{
566
- failed: "failed";
567
566
  ongoing: "ongoing";
568
567
  deployed: "deployed";
568
+ failed: "failed";
569
569
  canceled: "canceled";
570
570
  }>;
571
571
  sourceCommitId: z.ZodNullable<z.ZodString>;
@@ -583,9 +583,9 @@ declare const contract: {
583
583
  latestDeployment: z.ZodNullable<z.ZodObject<{
584
584
  id: z.ZodString;
585
585
  status: z.ZodEnum<{
586
- failed: "failed";
587
586
  ongoing: "ongoing";
588
587
  deployed: "deployed";
588
+ failed: "failed";
589
589
  canceled: "canceled";
590
590
  }>;
591
591
  sourceCommitId: z.ZodNullable<z.ZodString>;
@@ -816,7 +816,7 @@ declare const contract: {
816
816
  beacon: {
817
817
  create: {
818
818
  v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
819
- targetUrl: z.ZodString;
819
+ targetUrl: z.ZodURL;
820
820
  teamId: z.ZodOptional<z.ZodString>;
821
821
  projectId: z.ZodOptional<z.ZodString>;
822
822
  excludeCategories: z.ZodOptional<z.ZodArray<z.ZodEnum<{
@@ -840,10 +840,10 @@ declare const contract: {
840
840
  id: z.ZodString;
841
841
  targetUrl: z.ZodString;
842
842
  status: z.ZodEnum<{
843
+ failed: "failed";
843
844
  pending: "pending";
844
845
  partial: "partial";
845
846
  completed: "completed";
846
- failed: "failed";
847
847
  }>;
848
848
  durationMs: z.ZodNullable<z.ZodNumber>;
849
849
  createdAt: z.ZodCoercedDate<unknown>;
@@ -905,18 +905,18 @@ declare const contract: {
905
905
  chatgpt: "chatgpt";
906
906
  claudeai: "claudeai";
907
907
  }>, z.ZodBoolean>;
908
- widgetScreenshotKeys: z.ZodOptional<z.ZodObject<{
908
+ widgetScreenshotKeys: z.ZodObject<{
909
909
  chatgpt: z.ZodOptional<z.ZodString>;
910
910
  claudeai: z.ZodOptional<z.ZodString>;
911
- }, z.core.$strip>>;
912
- widgetScreenshots: z.ZodOptional<z.ZodObject<{
911
+ }, z.core.$strip>;
912
+ widgetScreenshots: z.ZodObject<{
913
913
  chatgpt: z.ZodOptional<z.ZodObject<{
914
914
  url: z.ZodString;
915
915
  }, z.core.$strip>>;
916
916
  claudeai: z.ZodOptional<z.ZodObject<{
917
917
  url: z.ZodString;
918
918
  }, z.core.$strip>>;
919
- }, z.core.$strip>>;
919
+ }, z.core.$strip>;
920
920
  }, z.core.$strip>>;
921
921
  }, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
922
922
  NOT_FOUND: {};
@@ -927,6 +927,14 @@ declare const contract: {
927
927
  type RouterInput = InferContractRouterInputs<typeof contract>;
928
928
  type RouterOutput = InferContractRouterOutputs<typeof contract>;
929
929
  //#endregion
930
+ //#region ../domains/src/platforms/schemas.d.ts
931
+ declare const platformSchema: z.ZodEnum<{
932
+ chatgpt: "chatgpt";
933
+ claudeai: "claudeai";
934
+ }>;
935
+ type Platform = z.infer<typeof platformSchema>;
936
+ declare const PLATFORM_LABELS: Record<Platform, string>;
937
+ //#endregion
930
938
  //#region src/schemas.d.ts
931
939
  declare const environmentVariableSchema: z.ZodObject<{
932
940
  key: z.ZodString;
@@ -962,155 +970,6 @@ declare const transportSchema: z.ZodEnum<{
962
970
  streamablehttp: "streamablehttp";
963
971
  }>;
964
972
  type Transport = z.infer<typeof transportSchema>;
965
- declare const auditStatusSchema: z.ZodEnum<{
966
- pending: "pending";
967
- partial: "partial";
968
- completed: "completed";
969
- failed: "failed";
970
- }>;
971
- declare const platformSchema: z.ZodEnum<{
972
- chatgpt: "chatgpt";
973
- claudeai: "claudeai";
974
- }>;
975
- type Platform = z.infer<typeof platformSchema>;
976
- declare const checkSeveritySchema: z.ZodEnum<{
977
- error: "error";
978
- warning: "warning";
979
- info: "info";
980
- }>;
981
- type CheckSeverity = z.infer<typeof checkSeveritySchema>;
982
- declare const checkCategorySchema: z.ZodEnum<{
983
- connectivity: "connectivity";
984
- "tool-metadata": "tool-metadata";
985
- "resource-metadata": "resource-metadata";
986
- performance: "performance";
987
- e2e: "e2e";
988
- }>;
989
- type CheckCategory = z.infer<typeof checkCategorySchema>;
990
- declare const checkScopeSchema: z.ZodEnum<{
991
- server: "server";
992
- view: "view";
993
- }>;
994
- type CheckScope = z.infer<typeof checkScopeSchema>;
995
- declare const checkDetailSchema: z.ZodObject<{
996
- label: z.ZodString;
997
- value: z.ZodOptional<z.ZodString>;
998
- }, z.core.$strip>;
999
- type CheckDetail = z.infer<typeof checkDetailSchema>;
1000
- declare const checkResultSchema: z.ZodObject<{
1001
- checkId: z.ZodString;
1002
- checkName: z.ZodString;
1003
- description: z.ZodString;
1004
- status: z.ZodEnum<{
1005
- pending: "pending";
1006
- pass: "pass";
1007
- fail: "fail";
1008
- skip: "skip";
1009
- }>;
1010
- message: z.ZodString;
1011
- skipReason: z.ZodOptional<z.ZodString>;
1012
- severity: z.ZodEnum<{
1013
- error: "error";
1014
- warning: "warning";
1015
- info: "info";
1016
- }>;
1017
- category: z.ZodEnum<{
1018
- connectivity: "connectivity";
1019
- "tool-metadata": "tool-metadata";
1020
- "resource-metadata": "resource-metadata";
1021
- performance: "performance";
1022
- e2e: "e2e";
1023
- }>;
1024
- scope: z.ZodEnum<{
1025
- server: "server";
1026
- view: "view";
1027
- }>;
1028
- platforms: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
1029
- chatgpt: "chatgpt";
1030
- claudeai: "claudeai";
1031
- }>>>>;
1032
- durationMs: z.ZodNumber;
1033
- details: z.ZodOptional<z.ZodArray<z.ZodObject<{
1034
- label: z.ZodString;
1035
- value: z.ZodOptional<z.ZodString>;
1036
- }, z.core.$strip>>>;
1037
- hint: z.ZodOptional<z.ZodObject<{
1038
- text: z.ZodString;
1039
- }, z.core.$strip>>;
1040
- }, z.core.$strip>;
1041
- type CheckResult = z.infer<typeof checkResultSchema>;
1042
- declare const auditReportSchema: z.ZodObject<{
1043
- schemaVersion: z.ZodString;
1044
- auditId: z.ZodString;
1045
- targetUrl: z.ZodString;
1046
- startedAt: z.ZodString;
1047
- completedAt: z.ZodString;
1048
- durationMs: z.ZodNumber;
1049
- results: z.ZodArray<z.ZodObject<{
1050
- checkId: z.ZodString;
1051
- checkName: z.ZodString;
1052
- description: z.ZodString;
1053
- status: z.ZodEnum<{
1054
- pending: "pending";
1055
- pass: "pass";
1056
- fail: "fail";
1057
- skip: "skip";
1058
- }>;
1059
- message: z.ZodString;
1060
- skipReason: z.ZodOptional<z.ZodString>;
1061
- severity: z.ZodEnum<{
1062
- error: "error";
1063
- warning: "warning";
1064
- info: "info";
1065
- }>;
1066
- category: z.ZodEnum<{
1067
- connectivity: "connectivity";
1068
- "tool-metadata": "tool-metadata";
1069
- "resource-metadata": "resource-metadata";
1070
- performance: "performance";
1071
- e2e: "e2e";
1072
- }>;
1073
- scope: z.ZodEnum<{
1074
- server: "server";
1075
- view: "view";
1076
- }>;
1077
- platforms: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
1078
- chatgpt: "chatgpt";
1079
- claudeai: "claudeai";
1080
- }>>>>;
1081
- durationMs: z.ZodNumber;
1082
- details: z.ZodOptional<z.ZodArray<z.ZodObject<{
1083
- label: z.ZodString;
1084
- value: z.ZodOptional<z.ZodString>;
1085
- }, z.core.$strip>>>;
1086
- hint: z.ZodOptional<z.ZodObject<{
1087
- text: z.ZodString;
1088
- }, z.core.$strip>>;
1089
- }, z.core.$strip>>;
1090
- requiresAuth: z.ZodBoolean;
1091
- hasViewSupport: z.ZodBoolean;
1092
- viewPlatforms: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
1093
- chatgpt: "chatgpt";
1094
- claudeai: "claudeai";
1095
- }>>>>;
1096
- isReadyForPlatform: z.ZodRecord<z.ZodEnum<{
1097
- chatgpt: "chatgpt";
1098
- claudeai: "claudeai";
1099
- }>, z.ZodBoolean>;
1100
- widgetScreenshotKeys: z.ZodOptional<z.ZodObject<{
1101
- chatgpt: z.ZodOptional<z.ZodString>;
1102
- claudeai: z.ZodOptional<z.ZodString>;
1103
- }, z.core.$strip>>;
1104
- widgetScreenshots: z.ZodOptional<z.ZodObject<{
1105
- chatgpt: z.ZodOptional<z.ZodObject<{
1106
- url: z.ZodString;
1107
- }, z.core.$strip>>;
1108
- claudeai: z.ZodOptional<z.ZodObject<{
1109
- url: z.ZodString;
1110
- }, z.core.$strip>>;
1111
- }, z.core.$strip>>;
1112
- }, z.core.$strip>;
1113
- type AuditReport = z.infer<typeof auditReportSchema>;
1114
973
  declare const playgroundHeaderSchema: z.ZodObject<{
1115
974
  name: z.ZodString;
1116
975
  description: z.ZodString;
@@ -1145,4 +1004,4 @@ declare const serverFieldsSchema: z.ZodObject<{
1145
1004
  }, z.core.$strip>>>;
1146
1005
  }, z.core.$strip>;
1147
1006
  //#endregion
1148
- export { ApiContext, AuditReport, CheckCategory, CheckDetail, CheckResult, CheckScope, CheckSeverity, Platform, RouterInput, RouterOutput, Runtime, Transport, auditReportSchema, auditStatusSchema, buildSettingsSchema, checkCategorySchema, checkDetailSchema, checkResultSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, platformSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
1007
+ export { ApiContext, PLATFORM_LABELS, type Platform, RouterInput, RouterOutput, Runtime, Transport, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
package/dist/index.mjs CHANGED
@@ -1,6 +1,296 @@
1
+ import { z } from "zod";
1
2
  import { oc } from "@orpc/contract";
2
3
  import ms from "ms";
3
- import { z } from "zod";
4
+ const platformSchema = z.enum(["chatgpt", "claudeai"]);
5
+ const PLATFORM_LABELS = {
6
+ chatgpt: "ChatGPT",
7
+ claudeai: "Claude.ai"
8
+ };
9
+ const auditStatusSchema = z.enum([
10
+ "pending",
11
+ "partial",
12
+ "completed",
13
+ "failed"
14
+ ]);
15
+ const checkSeveritySchema = z.enum([
16
+ "error",
17
+ "warning",
18
+ "info"
19
+ ]);
20
+ const checkCategorySchema = z.enum([
21
+ "connectivity",
22
+ "tool-metadata",
23
+ "resource-metadata",
24
+ "performance",
25
+ "e2e"
26
+ ]);
27
+ const checkScopeSchema = z.enum(["server", "view"]);
28
+ const checkDetailSchema = z.object({
29
+ label: z.string(),
30
+ value: z.string().optional()
31
+ });
32
+ const checkResultSchema = z.object({
33
+ checkId: z.string(),
34
+ checkName: z.string(),
35
+ description: z.string(),
36
+ status: z.enum([
37
+ "pass",
38
+ "fail",
39
+ "skip",
40
+ "pending"
41
+ ]),
42
+ message: z.string(),
43
+ skipReason: z.string().optional(),
44
+ severity: checkSeveritySchema,
45
+ category: checkCategorySchema,
46
+ scope: checkScopeSchema,
47
+ platforms: z.array(platformSchema).readonly().optional(),
48
+ durationMs: z.number(),
49
+ details: z.array(checkDetailSchema).optional(),
50
+ hint: z.object({ text: z.string() }).optional()
51
+ });
52
+ const auditReportSchema = z.object({
53
+ schemaVersion: z.string(),
54
+ auditId: z.string(),
55
+ targetUrl: z.string(),
56
+ startedAt: z.string(),
57
+ completedAt: z.string(),
58
+ durationMs: z.number(),
59
+ results: z.array(checkResultSchema),
60
+ requiresAuth: z.boolean(),
61
+ hasViewSupport: z.boolean(),
62
+ viewPlatforms: z.array(platformSchema).readonly().optional(),
63
+ isReadyForPlatform: z.record(platformSchema, z.boolean()),
64
+ widgetScreenshotKeys: z.object({
65
+ chatgpt: z.string().optional(),
66
+ claudeai: z.string().optional()
67
+ })
68
+ });
69
+ const widgetScreenshotSchema = z.object({ url: z.string() });
70
+ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreenshots: z.object({
71
+ chatgpt: widgetScreenshotSchema.optional(),
72
+ claudeai: widgetScreenshotSchema.optional()
73
+ }) });
74
+ z.object({
75
+ id: z.string(),
76
+ createdAt: z.coerce.date(),
77
+ environmentId: z.string(),
78
+ content: z.string(),
79
+ source: z.enum(["model", "user"])
80
+ });
81
+ z.object({
82
+ content: z.string(),
83
+ source: z.enum(["model", "user"])
84
+ });
85
+ const toolDefinitionSchema = z.object({
86
+ name: z.string(),
87
+ title: z.string().optional(),
88
+ description: z.string().optional(),
89
+ annotations: z.object({
90
+ readOnlyHint: z.boolean().optional(),
91
+ destructiveHint: z.boolean().optional(),
92
+ openWorldHint: z.boolean().optional(),
93
+ idempotentHint: z.boolean().optional()
94
+ }).optional()
95
+ });
96
+ const positiveTestCaseSchema = z.object({
97
+ scenario: z.string(),
98
+ userPrompt: z.string(),
99
+ toolTriggered: z.string().optional(),
100
+ expectedOutput: z.string().optional()
101
+ }).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
102
+ /** Accepts either a valid email or URL. */
103
+ const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
104
+ const chatgptCategorySchema = z.enum([
105
+ "BUSINESS",
106
+ "COLLABORATION",
107
+ "DESIGN",
108
+ "DEVELOPER_TOOLS",
109
+ "EDUCATION",
110
+ "ENTERTAINMENT",
111
+ "FINANCE",
112
+ "FOOD",
113
+ "LIFESTYLE",
114
+ "NEWS",
115
+ "PRODUCTIVITY",
116
+ "SHOPPING",
117
+ "TRAVEL"
118
+ ]);
119
+ const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
120
+ const chatgptAllowedCountriesSchema = z.enum(["Allow all", "Restrict to specific countries"]);
121
+ const negativeTestCaseSchema = z.object({
122
+ scenario: z.string(),
123
+ userPrompt: z.string()
124
+ }).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
125
+ const chatgptToolJustificationSchema = z.object({
126
+ toolName: z.string(),
127
+ readOnlyJustification: z.string(),
128
+ openWorldJustification: z.string(),
129
+ destructiveJustification: z.string()
130
+ }).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
131
+ const chatgptTranslationSchema = z.object({
132
+ locale: z.string(),
133
+ tagline: z.string().optional(),
134
+ description: z.string().optional()
135
+ }).describe("Locale-scoped override for tagline + description. English (US) is the default.");
136
+ /**
137
+ * Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
138
+ * When adding/removing/reordering fields, keep this in sync with the sheet.
139
+ */
140
+ const chatgptSubmissionFormDataSchema = z.object({
141
+ logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
142
+ logoDark: z.string().describe("Logo icon for dark mode. Square PNG. Same specs as the light icon."),
143
+ appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
144
+ tagline: z.string().max(30).describe("Plain-language phrase focused on function and user value. 30 chars max."),
145
+ description: z.string().describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
146
+ category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
147
+ developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
148
+ companyUrl: z.url().describe("Your company's main website URL."),
149
+ supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
150
+ privacyPolicyUrl: z.url().describe("URL to your privacy policy."),
151
+ termsOfServiceUrl: z.url().describe("URL to the app's terms of service."),
152
+ 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."),
153
+ 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."),
154
+ serverUrl: z.url().describe("URL of the MCP server."),
155
+ authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
156
+ tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
157
+ toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
158
+ 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."),
159
+ negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases — prompts where the app should NOT trigger but the model might think it's relevant."),
160
+ 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."),
161
+ translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
162
+ allowedCountries: chatgptAllowedCountriesSchema.describe("'Allow all' or restrict to a specific list. See OpenAI's supported countries list."),
163
+ releaseNotes: z.string().describe("Publicly displayed on the app details page.")
164
+ });
165
+ chatgptSubmissionFormDataSchema.pick({
166
+ appName: true,
167
+ developerName: true,
168
+ serverUrl: true,
169
+ tools: true,
170
+ authentication: true
171
+ }).partial();
172
+ const claudeCategorySchema = z.enum([
173
+ "Business & Productivity",
174
+ "Communication",
175
+ "Data & Analytics",
176
+ "Development tools",
177
+ "Financial Services",
178
+ "Consumer Health",
179
+ "Health & Life Sciences",
180
+ "Media & Entertainment",
181
+ "Commerce & Shopping"
182
+ ]);
183
+ z.enum([
184
+ "No auth needed",
185
+ "OAuth 2.0",
186
+ "Custom URL"
187
+ ]);
188
+ const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
189
+ z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
190
+ const claudeReadWriteCapabilitiesSchema = z.enum([
191
+ "Read only",
192
+ "Write only",
193
+ "Read + write"
194
+ ]);
195
+ const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
196
+ const claudeThirdPartySchema = z.enum([
197
+ "Web access (open web fetch / scraping / arbitrary URLs)",
198
+ "Third-party AI model integration",
199
+ "Third-party data retrieval (via workflow / aggregator)",
200
+ "Third-party data modification (via workflow / aggregator)",
201
+ "N/A"
202
+ ]);
203
+ const claudeDataHandlingSchema = z.enum([
204
+ "Server only accesses data explicitly requested by user",
205
+ "No data is stored beyond session requirements",
206
+ "Data transmission is encrypted (HTTPS / TLS)",
207
+ "GDPR compliant (if applicable)"
208
+ ]);
209
+ const claudeSponsoredContentSchema = z.enum([
210
+ "No, there is no sponsored content or advertisements",
211
+ "Yes, there are banner ads or other paid visual elements",
212
+ "Yes, returned content or ranking is impacted by sponsorship or ad placement"
213
+ ]);
214
+ /**
215
+ * Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
216
+ * When adding/removing/reordering fields, keep this in sync with the sheet.
217
+ */
218
+ const claudeSubmissionFormDataSchema = z.object({
219
+ 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."),
220
+ 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."),
221
+ 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."),
222
+ 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."),
223
+ 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."),
224
+ 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."),
225
+ appName: z.string().describe(`The public display name for your connector as it will appear in the Connectors Directory.
226
+
227
+ Rules:
228
+ (1) Do NOT include the words 'MCP' or 'Server' — these are auto-rejected.
229
+ (2) Use your brand/product name, e.g. 'Notion', 'Linear', 'Slack'.
230
+ (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.`),
231
+ mcpUrlType: claudeMcpUrlTypeSchema.describe("Universal URL = one URL serves all users. Custom MCP URLs = signup URL + regex matching per-user URLs."),
232
+ serverUrl: z.url().describe("Production MCP server URL (https). Derived from the project's production environment by default."),
233
+ tagline: z.string().max(55).describe("Short blurb shown below the server name. 55 chars max."),
234
+ description: z.string().describe("50–100 words describing what the server does and its key capabilities. Lives on the directory listing."),
235
+ testCases: z.array(positiveTestCaseSchema).describe("At least 3 use cases with example prompts showing the value of the connector."),
236
+ connectionRequirements: z.string().describe(`Prerequisites before connecting:
237
+ • Free/premium account
238
+ • Admin seat
239
+ • Geographic availability
240
+ • Custom instance URL
241
+
242
+ State 'No special requirements.' if none.`),
243
+ readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe("Inferred from the `readOnlyHint` annotations on the MCP tools."),
244
+ isMcpApp: z.boolean().describe("True if the server exposes interactive UI elements (widgets). Inferred from the MCP connection."),
245
+ thirdPartyConnectionsAndWebAccess: z.array(claudeThirdPartySchema).describe("Multi-select of what the server reaches out to (web, third-party AI, data aggregators)."),
246
+ dataHandling: z.array(claudeDataHandlingSchema).describe("Multi-select of data-handling practices that accurately describe the server. Cannot be inferred — user must self-declare."),
247
+ personalDataHealthAccess: z.boolean().describe("True only if the connector gives users access to their own personal health data (medical records, lab results, health metrics)."),
248
+ categories: z.array(claudeCategorySchema).describe("Multi-select of categories that best describe the server in the directory."),
249
+ sponsoredContentsOrAdvertisement: claudeSponsoredContentSchema.describe("Disclose paid promotion or sponsored content. Cannot be filled by Alpic — user must self-declare."),
250
+ transportSupport: z.array(claudeTransportSchema).describe("Multi-select of transport protocols the server supports. Anthropic recommends Streamable HTTP (SSE may be deprecated later this year)."),
251
+ serverDocumentationLink: z.url().describe("Public docs URL covering what the MCP does, setup, debugging, and self-serve support. The Alpic playground may be used."),
252
+ privacyPolicyUrl: z.url().describe("URL to your privacy policy. Mandatory and displayed alongside the directory listing."),
253
+ supportChannel: supportChannelSchema.describe("Link or email for user support (help center, GitHub issues, docs, support@…). Displayed alongside the directory listing."),
254
+ 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."),
255
+ tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
256
+ toolTitlesAnnotationsConfirmed: z.boolean().describe("Confirmation that all tools have user-friendly titles and accurate annotations (readOnlyHint, destructiveHint, …)."),
257
+ logoLight: z.string().describe("Server/app logo for light mode. Square 1:1 aspect ratio. SVG preferred for Claude."),
258
+ 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.")
259
+ });
260
+ claudeSubmissionFormDataSchema.pick({
261
+ companyName: true,
262
+ appName: true,
263
+ mcpUrlType: true,
264
+ serverUrl: true,
265
+ tools: true,
266
+ readWriteCapabilities: true,
267
+ transportSupport: true,
268
+ primaryContactEmail: true,
269
+ primaryContactName: true
270
+ }).partial();
271
+ const submissionMetaFieldsSchema = z.object({
272
+ id: z.string(),
273
+ environmentId: z.string(),
274
+ createdAt: z.coerce.date(),
275
+ updatedAt: z.coerce.date()
276
+ });
277
+ const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
278
+ platform: z.literal("claudeai"),
279
+ formData: claudeSubmissionFormDataSchema.partial()
280
+ });
281
+ const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
282
+ platform: z.literal("chatgpt"),
283
+ formData: chatgptSubmissionFormDataSchema.partial()
284
+ });
285
+ z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
286
+ z.union([claudeSubmissionFormDataSchema.partial(), chatgptSubmissionFormDataSchema.partial()]);
287
+ const subscriptionPlanSchema = z.enum([
288
+ "pro",
289
+ "business",
290
+ "enterprise"
291
+ ]);
292
+ z.object({ plan: subscriptionPlanSchema.nullable() });
293
+ //#endregion
4
294
  //#region src/schemas.ts
5
295
  const RESERVED_KEYS = [
6
296
  "_HANDLER",
@@ -35,7 +325,8 @@ const RESERVED_KEYS = [
35
325
  "BUILD_ARG_BUILD_OUTPUT_DIR",
36
326
  "BUILD_ARG_START_COMMAND",
37
327
  "ALPIC_HOST",
38
- "ALPIC_CUSTOM_DOMAINS"
328
+ "ALPIC_CUSTOM_DOMAINS",
329
+ "ALPIC_INTENT_META_KEY"
39
330
  ];
40
331
  const environmentVariableSchema = z.object({
41
332
  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"),
@@ -64,71 +355,6 @@ const transportSchema = z.enum([
64
355
  "sse",
65
356
  "streamablehttp"
66
357
  ]);
67
- const auditStatusSchema = z.enum([
68
- "pending",
69
- "partial",
70
- "completed",
71
- "failed"
72
- ]);
73
- const platformSchema = z.enum(["chatgpt", "claudeai"]);
74
- const checkSeveritySchema = z.enum([
75
- "error",
76
- "warning",
77
- "info"
78
- ]);
79
- const checkCategorySchema = z.enum([
80
- "connectivity",
81
- "tool-metadata",
82
- "resource-metadata",
83
- "performance",
84
- "e2e"
85
- ]);
86
- const checkScopeSchema = z.enum(["server", "view"]);
87
- const checkDetailSchema = z.object({
88
- label: z.string(),
89
- value: z.string().optional()
90
- });
91
- const checkResultSchema = z.object({
92
- checkId: z.string(),
93
- checkName: z.string(),
94
- description: z.string(),
95
- status: z.enum([
96
- "pass",
97
- "fail",
98
- "skip",
99
- "pending"
100
- ]),
101
- message: z.string(),
102
- skipReason: z.string().optional(),
103
- severity: checkSeveritySchema,
104
- category: checkCategorySchema,
105
- scope: checkScopeSchema,
106
- platforms: z.array(platformSchema).readonly().optional(),
107
- durationMs: z.number(),
108
- details: z.array(checkDetailSchema).optional(),
109
- hint: z.object({ text: z.string() }).optional()
110
- });
111
- const auditReportSchema = z.object({
112
- schemaVersion: z.string(),
113
- auditId: z.string(),
114
- targetUrl: z.string(),
115
- startedAt: z.string(),
116
- completedAt: z.string(),
117
- durationMs: z.number(),
118
- results: z.array(checkResultSchema),
119
- requiresAuth: z.boolean(),
120
- hasViewSupport: z.boolean(),
121
- viewPlatforms: z.array(platformSchema).readonly().optional(),
122
- isReadyForPlatform: z.record(platformSchema, z.boolean()),
123
- widgetScreenshotKeys: z.object({
124
- chatgpt: z.string().optional(),
125
- claudeai: z.string().optional()
126
- }).optional(),
127
- widgetScreenshots: z.object({
128
- chatgpt: z.object({ url: z.string() }).optional(),
129
- claudeai: z.object({ url: z.string() }).optional()
130
- }).optional()
131
- });
132
358
  const playgroundHeaderSchema = z.object({
133
359
  name: z.string().min(1).max(100),
134
360
  description: z.string().max(200),
@@ -693,7 +919,7 @@ const createBeaconContractV1 = oc.route({
693
919
  NOT_FOUND: {},
694
920
  BAD_REQUEST: {}
695
921
  }).input(z.object({
696
- targetUrl: z.string().url().describe("The HTTPS URL of the MCP server to audit"),
922
+ targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
697
923
  teamId: z.string().optional().describe("The team ID to associate the audit with"),
698
924
  projectId: z.string().optional().describe("The project ID to associate the audit with"),
699
925
  excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
@@ -711,7 +937,7 @@ const getBeaconContractV1 = oc.route({
711
937
  status: auditStatusSchema,
712
938
  durationMs: z.number().nullable(),
713
939
  createdAt: z.coerce.date(),
714
- report: auditReportSchema.nullable()
940
+ report: auditReportWithScreenshotsSchema.nullable()
715
941
  }));
716
942
  const contract = {
717
943
  teams: { list: { v1: listTeamsContractV1 } },
@@ -757,4 +983,4 @@ const contract = {
757
983
  }
758
984
  };
759
985
  //#endregion
760
- export { auditReportSchema, auditStatusSchema, buildSettingsSchema, checkCategorySchema, checkDetailSchema, checkResultSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, platformSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
986
+ export { 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-staging.f2b9397",
3
+ "version": "0.0.0-staging.f31741c",
4
4
  "description": "Contract for the Alpic API",
5
5
  "type": "module",
6
6
  "main": "./dist/index.mjs",
@@ -14,20 +14,32 @@
14
14
  "files": [
15
15
  "dist"
16
16
  ],
17
+ "nx": {
18
+ "targets": {
19
+ "build": {
20
+ "dependsOn": [
21
+ "^build"
22
+ ]
23
+ }
24
+ }
25
+ },
17
26
  "author": "Alpic",
18
27
  "license": "ISC",
19
28
  "dependencies": {
20
- "@orpc/contract": "^1.13.14",
29
+ "@orpc/contract": "^1.14.3",
21
30
  "ms": "^2.1.3",
22
- "zod": "^4.3.6"
31
+ "zod": "^4.4.3"
23
32
  },
24
33
  "devDependencies": {
34
+ "@orpc/openapi": "^1.14.3",
35
+ "@orpc/zod": "^1.14.3",
25
36
  "@total-typescript/tsconfig": "^1.0.4",
26
37
  "@types/ms": "^2.1.0",
27
38
  "shx": "^0.4.0",
28
- "tsdown": "^0.21.8",
29
- "typescript": "^6.0.2",
30
- "vitest": "^4.1.4"
39
+ "tsdown": "^0.22.0",
40
+ "typescript": "^6.0.3",
41
+ "vitest": "^4.1.6",
42
+ "@alpic-ai/domains": "0.0.0"
31
43
  },
32
44
  "scripts": {
33
45
  "build": "shx rm -rf dist && tsdown",