@alpic-ai/api 0.0.0-staging.gf0dc7b2 → 0.0.0-staging.gf23a958
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 +69 -57
- package/dist/index.mjs +159 -208
- package/package.json +6 -6
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
|
-
import * as _$_orpc_contract0 from "@orpc/contract";
|
|
3
2
|
import { InferContractRouterInputs, InferContractRouterOutputs } from "@orpc/contract";
|
|
4
3
|
|
|
5
4
|
//#region src/api.contract.d.ts
|
|
@@ -16,7 +15,7 @@ declare const deploymentStatusSchema: z.ZodEnum<{
|
|
|
16
15
|
failed: "failed";
|
|
17
16
|
canceled: "canceled";
|
|
18
17
|
}>;
|
|
19
|
-
declare const createEnvironmentContractV1:
|
|
18
|
+
declare const createEnvironmentContractV1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
20
19
|
projectId: z.ZodString;
|
|
21
20
|
name: z.ZodString;
|
|
22
21
|
sourceBranch: z.ZodString;
|
|
@@ -32,14 +31,14 @@ declare const createEnvironmentContractV1: _$_orpc_contract0.ContractProcedureBu
|
|
|
32
31
|
urls: z.ZodArray<z.ZodURL>;
|
|
33
32
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
34
33
|
projectId: z.ZodString;
|
|
35
|
-
}, z.core.$strip>,
|
|
34
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
36
35
|
NOT_FOUND: {};
|
|
37
36
|
BAD_REQUEST: {};
|
|
38
37
|
}>, Record<never, never>>;
|
|
39
38
|
declare const contract: {
|
|
40
39
|
teams: {
|
|
41
40
|
list: {
|
|
42
|
-
v1:
|
|
41
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, z.ZodArray<z.ZodObject<{
|
|
43
42
|
id: z.ZodString;
|
|
44
43
|
name: z.ZodString;
|
|
45
44
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
@@ -49,7 +48,7 @@ declare const contract: {
|
|
|
49
48
|
};
|
|
50
49
|
analytics: {
|
|
51
50
|
get: {
|
|
52
|
-
v1:
|
|
51
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
53
52
|
projectId: z.ZodString;
|
|
54
53
|
startTimestamp: z.ZodCoercedNumber<unknown>;
|
|
55
54
|
endTimestamp: z.ZodCoercedNumber<unknown>;
|
|
@@ -92,7 +91,7 @@ declare const contract: {
|
|
|
92
91
|
categories: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
93
92
|
}, z.core.$strip>>;
|
|
94
93
|
}, z.core.$strip>;
|
|
95
|
-
}, z.core.$strip>,
|
|
94
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
96
95
|
NOT_FOUND: {};
|
|
97
96
|
BAD_REQUEST: {};
|
|
98
97
|
}>, Record<never, never>>;
|
|
@@ -100,7 +99,7 @@ declare const contract: {
|
|
|
100
99
|
};
|
|
101
100
|
deployments: {
|
|
102
101
|
list: {
|
|
103
|
-
v1:
|
|
102
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
104
103
|
projectId: z.ZodString;
|
|
105
104
|
status: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
106
105
|
ongoing: "ongoing";
|
|
@@ -128,12 +127,12 @@ declare const contract: {
|
|
|
128
127
|
environmentName: z.ZodString;
|
|
129
128
|
isCurrent: z.ZodBoolean;
|
|
130
129
|
deploymentPageUrl: z.ZodNullable<z.ZodURL>;
|
|
131
|
-
}, z.core.$strip>>,
|
|
130
|
+
}, z.core.$strip>>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
132
131
|
NOT_FOUND: {};
|
|
133
132
|
}>, Record<never, never>>;
|
|
134
133
|
};
|
|
135
134
|
get: {
|
|
136
|
-
v1:
|
|
135
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
137
136
|
deploymentId: z.ZodString;
|
|
138
137
|
}, z.core.$strip>, z.ZodObject<{
|
|
139
138
|
id: z.ZodString;
|
|
@@ -154,24 +153,24 @@ declare const contract: {
|
|
|
154
153
|
environmentName: z.ZodString;
|
|
155
154
|
isCurrent: z.ZodBoolean;
|
|
156
155
|
deploymentPageUrl: z.ZodNullable<z.ZodURL>;
|
|
157
|
-
}, z.core.$strip>,
|
|
156
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
158
157
|
NOT_FOUND: {};
|
|
159
158
|
}>, Record<never, never>>;
|
|
160
159
|
};
|
|
161
160
|
uploadArtifact: {
|
|
162
|
-
v1:
|
|
161
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodOptional<z.ZodObject<{
|
|
163
162
|
teamId: z.ZodOptional<z.ZodString>;
|
|
164
163
|
}, z.core.$strip>>, z.ZodObject<{
|
|
165
164
|
uploadUrl: z.ZodURL;
|
|
166
165
|
token: z.ZodString;
|
|
167
166
|
expiresAt: z.ZodCoercedDate<unknown>;
|
|
168
|
-
}, z.core.$strip>,
|
|
167
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
169
168
|
NOT_FOUND: {};
|
|
170
169
|
BAD_REQUEST: {};
|
|
171
170
|
}>, Record<never, never>>;
|
|
172
171
|
};
|
|
173
172
|
getLogs: {
|
|
174
|
-
v1:
|
|
173
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
175
174
|
deploymentId: z.ZodString;
|
|
176
175
|
}, z.core.$strip>, z.ZodObject<{
|
|
177
176
|
logs: z.ZodArray<z.ZodObject<{
|
|
@@ -179,14 +178,14 @@ declare const contract: {
|
|
|
179
178
|
content: z.ZodOptional<z.ZodString>;
|
|
180
179
|
}, z.core.$strip>>;
|
|
181
180
|
hasMoreLogs: z.ZodBoolean;
|
|
182
|
-
}, z.core.$strip>,
|
|
181
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
183
182
|
NOT_FOUND: {};
|
|
184
183
|
}>, Record<never, never>>;
|
|
185
184
|
};
|
|
186
185
|
};
|
|
187
186
|
environments: {
|
|
188
187
|
create: {
|
|
189
|
-
v1:
|
|
188
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
190
189
|
projectId: z.ZodString;
|
|
191
190
|
name: z.ZodString;
|
|
192
191
|
sourceBranch: z.ZodString;
|
|
@@ -202,13 +201,13 @@ declare const contract: {
|
|
|
202
201
|
urls: z.ZodArray<z.ZodURL>;
|
|
203
202
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
204
203
|
projectId: z.ZodString;
|
|
205
|
-
}, z.core.$strip>,
|
|
204
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
206
205
|
NOT_FOUND: {};
|
|
207
206
|
BAD_REQUEST: {};
|
|
208
207
|
}>, Record<never, never>>;
|
|
209
208
|
};
|
|
210
209
|
get: {
|
|
211
|
-
v1:
|
|
210
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
212
211
|
environmentId: z.ZodString;
|
|
213
212
|
}, z.core.$strip>, z.ZodObject<{
|
|
214
213
|
id: z.ZodString;
|
|
@@ -218,12 +217,12 @@ declare const contract: {
|
|
|
218
217
|
domains: z.ZodArray<z.ZodCustomStringFormat<"hostname">>;
|
|
219
218
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
220
219
|
projectId: z.ZodString;
|
|
221
|
-
}, z.core.$strip>,
|
|
220
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
222
221
|
NOT_FOUND: {};
|
|
223
222
|
}>, Record<never, never>>;
|
|
224
223
|
};
|
|
225
224
|
deploy: {
|
|
226
|
-
v1:
|
|
225
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
227
226
|
environmentId: z.ZodString;
|
|
228
227
|
token: z.ZodOptional<z.ZodString>;
|
|
229
228
|
}, z.core.$strip>, z.ZodObject<{
|
|
@@ -245,13 +244,13 @@ declare const contract: {
|
|
|
245
244
|
environmentName: z.ZodString;
|
|
246
245
|
isCurrent: z.ZodBoolean;
|
|
247
246
|
deploymentPageUrl: z.ZodNullable<z.ZodURL>;
|
|
248
|
-
}, z.core.$strip>,
|
|
247
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
249
248
|
NOT_FOUND: {};
|
|
250
249
|
BAD_REQUEST: {};
|
|
251
250
|
}>, Record<never, never>>;
|
|
252
251
|
};
|
|
253
252
|
getLogs: {
|
|
254
|
-
v1:
|
|
253
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
255
254
|
environmentId: z.ZodString;
|
|
256
255
|
since: z.ZodOptional<z.ZodString>;
|
|
257
256
|
until: z.ZodOptional<z.ZodString>;
|
|
@@ -281,13 +280,13 @@ declare const contract: {
|
|
|
281
280
|
durationInMs: z.ZodOptional<z.ZodNumber>;
|
|
282
281
|
}, z.core.$strip>>;
|
|
283
282
|
nextToken: z.ZodNullable<z.ZodString>;
|
|
284
|
-
}, z.core.$strip>,
|
|
283
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
285
284
|
NOT_FOUND: {};
|
|
286
285
|
BAD_REQUEST: {};
|
|
287
286
|
}>, Record<never, never>>;
|
|
288
287
|
};
|
|
289
288
|
getLatestLogs: {
|
|
290
|
-
v1:
|
|
289
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
291
290
|
environmentId: z.ZodString;
|
|
292
291
|
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
293
292
|
level: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
@@ -313,7 +312,7 @@ declare const contract: {
|
|
|
313
312
|
method: z.ZodOptional<z.ZodString>;
|
|
314
313
|
durationInMs: z.ZodOptional<z.ZodNumber>;
|
|
315
314
|
}, z.core.$strip>>;
|
|
316
|
-
}, z.core.$strip>,
|
|
315
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
317
316
|
NOT_FOUND: {};
|
|
318
317
|
BAD_REQUEST: {};
|
|
319
318
|
}>, Record<never, never>>;
|
|
@@ -321,7 +320,7 @@ declare const contract: {
|
|
|
321
320
|
};
|
|
322
321
|
environmentVariables: {
|
|
323
322
|
list: {
|
|
324
|
-
v1:
|
|
323
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
325
324
|
environmentId: z.ZodString;
|
|
326
325
|
}, z.core.$strip>, z.ZodArray<z.ZodObject<{
|
|
327
326
|
id: z.ZodString;
|
|
@@ -329,12 +328,12 @@ declare const contract: {
|
|
|
329
328
|
value: z.ZodString;
|
|
330
329
|
isSecret: z.ZodBoolean;
|
|
331
330
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
332
|
-
}, z.core.$strip>>,
|
|
331
|
+
}, z.core.$strip>>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
333
332
|
NOT_FOUND: {};
|
|
334
333
|
}>, Record<never, never>>;
|
|
335
334
|
};
|
|
336
335
|
create: {
|
|
337
|
-
v1:
|
|
336
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
338
337
|
environmentId: z.ZodString;
|
|
339
338
|
environmentVariables: z.ZodArray<z.ZodObject<{
|
|
340
339
|
key: z.ZodString;
|
|
@@ -343,30 +342,30 @@ declare const contract: {
|
|
|
343
342
|
}, z.core.$strip>>;
|
|
344
343
|
}, z.core.$strip>, z.ZodObject<{
|
|
345
344
|
success: z.ZodLiteral<true>;
|
|
346
|
-
}, z.core.$strip>,
|
|
345
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
347
346
|
NOT_FOUND: {};
|
|
348
347
|
BAD_REQUEST: {};
|
|
349
348
|
}>, Record<never, never>>;
|
|
350
349
|
};
|
|
351
350
|
update: {
|
|
352
|
-
v1:
|
|
351
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
353
352
|
environmentVariableId: z.ZodString;
|
|
354
353
|
key: z.ZodString;
|
|
355
354
|
value: z.ZodOptional<z.ZodString>;
|
|
356
355
|
isSecret: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
357
356
|
}, z.core.$strip>, z.ZodObject<{
|
|
358
357
|
success: z.ZodLiteral<true>;
|
|
359
|
-
}, z.core.$strip>,
|
|
358
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
360
359
|
NOT_FOUND: {};
|
|
361
360
|
BAD_REQUEST: {};
|
|
362
361
|
}>, Record<never, never>>;
|
|
363
362
|
};
|
|
364
363
|
delete: {
|
|
365
|
-
v1:
|
|
364
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
366
365
|
environmentVariableId: z.ZodString;
|
|
367
366
|
}, z.core.$strip>, z.ZodObject<{
|
|
368
367
|
success: z.ZodLiteral<true>;
|
|
369
|
-
}, z.core.$strip>,
|
|
368
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
370
369
|
NOT_FOUND: {};
|
|
371
370
|
BAD_REQUEST: {};
|
|
372
371
|
}>, Record<never, never>>;
|
|
@@ -374,7 +373,7 @@ declare const contract: {
|
|
|
374
373
|
};
|
|
375
374
|
projects: {
|
|
376
375
|
update: {
|
|
377
|
-
v1:
|
|
376
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
378
377
|
projectId: z.ZodString;
|
|
379
378
|
name: z.ZodOptional<z.ZodString>;
|
|
380
379
|
sourceRepository: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
@@ -446,13 +445,14 @@ declare const contract: {
|
|
|
446
445
|
completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
|
|
447
446
|
}, z.core.$strip>>;
|
|
448
447
|
}, z.core.$strip>>;
|
|
449
|
-
}, z.core.$strip>,
|
|
448
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
450
449
|
NOT_FOUND: {};
|
|
451
450
|
BAD_REQUEST: {};
|
|
451
|
+
FORBIDDEN: {};
|
|
452
452
|
}>, Record<never, never>>;
|
|
453
453
|
};
|
|
454
454
|
get: {
|
|
455
|
-
v1:
|
|
455
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
456
456
|
projectId: z.ZodString;
|
|
457
457
|
}, z.core.$strip>, z.ZodObject<{
|
|
458
458
|
id: z.ZodString;
|
|
@@ -522,12 +522,12 @@ declare const contract: {
|
|
|
522
522
|
completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
|
|
523
523
|
}, z.core.$strip>>;
|
|
524
524
|
}, z.core.$strip>>;
|
|
525
|
-
}, z.core.$strip>,
|
|
525
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
526
526
|
NOT_FOUND: {};
|
|
527
527
|
}>, Record<never, never>>;
|
|
528
528
|
};
|
|
529
529
|
list: {
|
|
530
|
-
v1:
|
|
530
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodOptional<z.ZodObject<{
|
|
531
531
|
teamId: z.ZodOptional<z.ZodString>;
|
|
532
532
|
}, z.core.$strip>>, z.ZodArray<z.ZodObject<{
|
|
533
533
|
id: z.ZodString;
|
|
@@ -597,13 +597,13 @@ declare const contract: {
|
|
|
597
597
|
completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
|
|
598
598
|
}, z.core.$strip>>;
|
|
599
599
|
}, z.core.$strip>>;
|
|
600
|
-
}, z.core.$strip>>,
|
|
600
|
+
}, z.core.$strip>>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
601
601
|
NOT_FOUND: {};
|
|
602
602
|
BAD_REQUEST: {};
|
|
603
603
|
}>, Record<never, never>>;
|
|
604
604
|
};
|
|
605
605
|
create: {
|
|
606
|
-
v1:
|
|
606
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
607
607
|
teamId: z.ZodOptional<z.ZodString>;
|
|
608
608
|
name: z.ZodString;
|
|
609
609
|
sourceRepository: z.ZodOptional<z.ZodString>;
|
|
@@ -661,24 +661,25 @@ declare const contract: {
|
|
|
661
661
|
installCommand: z.ZodNullable<z.ZodString>;
|
|
662
662
|
startCommand: z.ZodNullable<z.ZodString>;
|
|
663
663
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
664
|
-
}, z.core.$strip>,
|
|
664
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
665
665
|
NOT_FOUND: {};
|
|
666
666
|
BAD_REQUEST: {};
|
|
667
|
+
FORBIDDEN: {};
|
|
667
668
|
}>, Record<never, never>>;
|
|
668
669
|
};
|
|
669
670
|
delete: {
|
|
670
|
-
v1:
|
|
671
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
671
672
|
projectId: z.ZodString;
|
|
672
673
|
}, z.core.$strip>, z.ZodObject<{
|
|
673
674
|
success: z.ZodLiteral<true>;
|
|
674
|
-
}, z.core.$strip>,
|
|
675
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
675
676
|
NOT_FOUND: {};
|
|
676
677
|
}>, Record<never, never>>;
|
|
677
678
|
};
|
|
678
679
|
};
|
|
679
680
|
playground: {
|
|
680
681
|
get: {
|
|
681
|
-
v1:
|
|
682
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
682
683
|
environmentId: z.ZodString;
|
|
683
684
|
}, z.core.$strip>, z.ZodObject<{
|
|
684
685
|
isPlaygroundEnabled: z.ZodBoolean;
|
|
@@ -696,12 +697,12 @@ declare const contract: {
|
|
|
696
697
|
prompt: z.ZodString;
|
|
697
698
|
}, z.core.$strip>>;
|
|
698
699
|
}, z.core.$strip>>;
|
|
699
|
-
}, z.core.$strip>,
|
|
700
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
700
701
|
NOT_FOUND: {};
|
|
701
702
|
}>, Record<never, never>>;
|
|
702
703
|
};
|
|
703
704
|
upsert: {
|
|
704
|
-
v1:
|
|
705
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
705
706
|
environmentId: z.ZodString;
|
|
706
707
|
isPlaygroundEnabled: z.ZodOptional<z.ZodBoolean>;
|
|
707
708
|
name: z.ZodOptional<z.ZodString>;
|
|
@@ -732,7 +733,7 @@ declare const contract: {
|
|
|
732
733
|
prompt: z.ZodString;
|
|
733
734
|
}, z.core.$strip>>;
|
|
734
735
|
}, z.core.$strip>>;
|
|
735
|
-
}, z.core.$strip>,
|
|
736
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
736
737
|
NOT_FOUND: {};
|
|
737
738
|
BAD_REQUEST: {};
|
|
738
739
|
}>, Record<never, never>>;
|
|
@@ -740,18 +741,18 @@ declare const contract: {
|
|
|
740
741
|
};
|
|
741
742
|
tunnels: {
|
|
742
743
|
getTicket: {
|
|
743
|
-
v1:
|
|
744
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, z.ZodObject<{
|
|
744
745
|
subdomain: z.ZodString;
|
|
745
746
|
ticket: z.ZodString;
|
|
746
747
|
tunnelHost: z.ZodString;
|
|
747
|
-
}, z.core.$strip>,
|
|
748
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
748
749
|
FORBIDDEN: {};
|
|
749
750
|
}>, Record<never, never>>;
|
|
750
751
|
};
|
|
751
752
|
};
|
|
752
753
|
distribution: {
|
|
753
754
|
publish: {
|
|
754
|
-
v1:
|
|
755
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
755
756
|
projectId: z.ZodString;
|
|
756
757
|
domain: z.ZodString;
|
|
757
758
|
title: z.ZodString;
|
|
@@ -783,13 +784,13 @@ declare const contract: {
|
|
|
783
784
|
}, z.core.$strip>>>;
|
|
784
785
|
}, z.core.$strip>>>;
|
|
785
786
|
}, z.core.$strip>;
|
|
786
|
-
}, z.core.$strip>,
|
|
787
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
787
788
|
NOT_FOUND: {};
|
|
788
789
|
BAD_REQUEST: {};
|
|
789
790
|
}>, Record<never, never>>;
|
|
790
791
|
};
|
|
791
792
|
get: {
|
|
792
|
-
v1:
|
|
793
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
793
794
|
projectId: z.ZodString;
|
|
794
795
|
domain: z.ZodString;
|
|
795
796
|
}, z.core.$strip>, z.ZodObject<{
|
|
@@ -816,7 +817,7 @@ declare const contract: {
|
|
|
816
817
|
}, z.core.$strip>>>;
|
|
817
818
|
}, z.core.$strip>>>;
|
|
818
819
|
}, z.core.$strip>;
|
|
819
|
-
}, z.core.$strip>,
|
|
820
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
820
821
|
NOT_FOUND: {};
|
|
821
822
|
BAD_REQUEST: {};
|
|
822
823
|
}>, Record<never, never>>;
|
|
@@ -824,7 +825,7 @@ declare const contract: {
|
|
|
824
825
|
};
|
|
825
826
|
beacon: {
|
|
826
827
|
create: {
|
|
827
|
-
v1:
|
|
828
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
828
829
|
targetUrl: z.ZodURL;
|
|
829
830
|
teamId: z.ZodOptional<z.ZodString>;
|
|
830
831
|
projectId: z.ZodOptional<z.ZodString>;
|
|
@@ -837,7 +838,7 @@ declare const contract: {
|
|
|
837
838
|
}>>>;
|
|
838
839
|
}, z.core.$strip>, z.ZodObject<{
|
|
839
840
|
id: z.ZodString;
|
|
840
|
-
}, z.core.$strip>,
|
|
841
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
841
842
|
NOT_FOUND: {};
|
|
842
843
|
BAD_REQUEST: {};
|
|
843
844
|
DNS_RESOLUTION_FAILED: {
|
|
@@ -846,7 +847,7 @@ declare const contract: {
|
|
|
846
847
|
}>, Record<never, never>>;
|
|
847
848
|
};
|
|
848
849
|
get: {
|
|
849
|
-
v1:
|
|
850
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
850
851
|
auditId: z.ZodString;
|
|
851
852
|
}, z.core.$strip>, z.ZodObject<{
|
|
852
853
|
id: z.ZodString;
|
|
@@ -930,7 +931,7 @@ declare const contract: {
|
|
|
930
931
|
}, z.core.$strip>>;
|
|
931
932
|
}, z.core.$strip>;
|
|
932
933
|
}, z.core.$strip>>;
|
|
933
|
-
}, z.core.$strip>,
|
|
934
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
934
935
|
NOT_FOUND: {};
|
|
935
936
|
}>, Record<never, never>>;
|
|
936
937
|
};
|
|
@@ -939,6 +940,17 @@ declare const contract: {
|
|
|
939
940
|
type RouterInput = InferContractRouterInputs<typeof contract>;
|
|
940
941
|
type RouterOutput = InferContractRouterOutputs<typeof contract>;
|
|
941
942
|
//#endregion
|
|
943
|
+
//#region src/auth-scope.d.ts
|
|
944
|
+
/** Credential scope required by an API route. */
|
|
945
|
+
type AuthScope = "any" | "user";
|
|
946
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
947
|
+
declare const AUTH_SCOPE_ANY = "any";
|
|
948
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
949
|
+
declare const AUTH_SCOPE_USER = "user";
|
|
950
|
+
type RouteAuthMeta = {
|
|
951
|
+
authScope?: AuthScope;
|
|
952
|
+
};
|
|
953
|
+
//#endregion
|
|
942
954
|
//#region ../domains/src/platforms/schemas.d.ts
|
|
943
955
|
declare const platformSchema: z.ZodEnum<{
|
|
944
956
|
chatgpt: "chatgpt";
|
|
@@ -1018,4 +1030,4 @@ declare const serverFieldsSchema: z.ZodObject<{
|
|
|
1018
1030
|
}, z.core.$strip>>>;
|
|
1019
1031
|
}, z.core.$strip>;
|
|
1020
1032
|
//#endregion
|
|
1021
|
-
export { ApiContext, PLATFORM_LABELS, type Platform, RouterInput, RouterOutput, Runtime, Transport, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
1033
|
+
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
|
*/
|
|
@@ -343,7 +343,7 @@ z.union([
|
|
|
343
343
|
]);
|
|
344
344
|
const allowedPlatformSchema = platformSchema;
|
|
345
345
|
const environmentDomainSchema = z.object({
|
|
346
|
-
|
|
346
|
+
name: z.string(),
|
|
347
347
|
status: z.enum([
|
|
348
348
|
"ongoing",
|
|
349
349
|
"deployed",
|
|
@@ -369,6 +369,12 @@ const environmentSchema$1 = z.object({
|
|
|
369
369
|
updatedAt: z.coerce.date()
|
|
370
370
|
});
|
|
371
371
|
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
372
|
+
z.object({
|
|
373
|
+
sessionReplayEnabled: z.boolean(),
|
|
374
|
+
collectRequestPayload: z.boolean(),
|
|
375
|
+
collectResponsePayload: z.boolean(),
|
|
376
|
+
collectErrorMessage: z.boolean()
|
|
377
|
+
});
|
|
372
378
|
z.object({
|
|
373
379
|
id: z.string(),
|
|
374
380
|
createdAt: z.coerce.date(),
|
|
@@ -503,7 +509,7 @@ z.object({
|
|
|
503
509
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
504
510
|
});
|
|
505
511
|
z.object({
|
|
506
|
-
|
|
512
|
+
name: z.string(),
|
|
507
513
|
createdAt: z.coerce.date(),
|
|
508
514
|
status: z.enum([
|
|
509
515
|
"ongoing",
|
|
@@ -567,10 +573,10 @@ const toolDefinitionSchema = z.object({
|
|
|
567
573
|
}).optional()
|
|
568
574
|
});
|
|
569
575
|
const positiveTestCaseSchema = z.object({
|
|
570
|
-
scenario: z.string(),
|
|
571
|
-
userPrompt: z.string(),
|
|
572
|
-
toolTriggered: z.string().optional(),
|
|
573
|
-
expectedOutput: z.string().optional()
|
|
576
|
+
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
577
|
+
userPrompt: z.string().describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
578
|
+
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
579
|
+
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
574
580
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
575
581
|
const screenshotEntrySchema = z.object({
|
|
576
582
|
prompt: z.string(),
|
|
@@ -578,6 +584,8 @@ const screenshotEntrySchema = z.object({
|
|
|
578
584
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
579
585
|
/** Accepts either a valid email or URL. */
|
|
580
586
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
587
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
588
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
581
589
|
const chatgptCategorySchema = z.enum([
|
|
582
590
|
"BUSINESS",
|
|
583
591
|
"COLLABORATION",
|
|
@@ -886,10 +894,10 @@ const negativeTestCaseSchema = z.object({
|
|
|
886
894
|
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
887
895
|
const chatgptToolJustificationSchema = z.object({
|
|
888
896
|
toolName: z.string(),
|
|
889
|
-
readOnlyJustification: z.string(),
|
|
890
|
-
openWorldJustification: z.string(),
|
|
891
|
-
destructiveJustification: z.string()
|
|
892
|
-
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
897
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
898
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
899
|
+
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
900
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
893
901
|
/**
|
|
894
902
|
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
895
903
|
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
@@ -911,23 +919,23 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
911
919
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
912
920
|
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."),
|
|
913
921
|
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
914
|
-
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value
|
|
915
|
-
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
|
|
922
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
923
|
+
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
924
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
917
925
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
918
|
-
companyUrl:
|
|
926
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
919
927
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
920
|
-
privacyPolicyUrl:
|
|
921
|
-
termsOfServiceUrl:
|
|
922
|
-
demoRecordingUrl:
|
|
928
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
929
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
930
|
+
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
931
|
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:
|
|
932
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
925
933
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
926
934
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
927
|
-
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
928
|
-
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output.
|
|
929
|
-
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases
|
|
930
|
-
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
|
|
935
|
+
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."),
|
|
936
|
+
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."),
|
|
937
|
+
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."),
|
|
938
|
+
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
939
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
932
940
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
933
941
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
@@ -948,7 +956,7 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
948
956
|
toolJustifications: true
|
|
949
957
|
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
950
958
|
const claudeCategorySchema = z.enum([
|
|
951
|
-
"
|
|
959
|
+
"Productivity",
|
|
952
960
|
"Communication",
|
|
953
961
|
"Data & Analytics",
|
|
954
962
|
"Development tools",
|
|
@@ -956,208 +964,143 @@ const claudeCategorySchema = z.enum([
|
|
|
956
964
|
"Consumer Health",
|
|
957
965
|
"Health & Life Sciences",
|
|
958
966
|
"Media & Entertainment",
|
|
959
|
-
"Commerce & Shopping"
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
"
|
|
963
|
-
"
|
|
964
|
-
"
|
|
967
|
+
"Commerce & Shopping",
|
|
968
|
+
"Legal",
|
|
969
|
+
"Sales and marketing",
|
|
970
|
+
"Creative",
|
|
971
|
+
"Nonprofit",
|
|
972
|
+
"Education",
|
|
973
|
+
"Other"
|
|
965
974
|
]);
|
|
966
|
-
const
|
|
967
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
975
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
968
976
|
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"
|
|
977
|
+
"read_only",
|
|
978
|
+
"write_only",
|
|
979
|
+
"read_write"
|
|
979
980
|
]);
|
|
980
|
-
const
|
|
981
|
-
"
|
|
982
|
-
"
|
|
983
|
-
"
|
|
984
|
-
"
|
|
985
|
-
"
|
|
981
|
+
const claudeAuthenticationSchema = z.enum([
|
|
982
|
+
"oauth_dcr",
|
|
983
|
+
"oauth_cimd",
|
|
984
|
+
"oauth_anthropic_creds",
|
|
985
|
+
"custom_connection",
|
|
986
|
+
"none"
|
|
986
987
|
]);
|
|
987
|
-
const
|
|
988
|
-
"
|
|
989
|
-
"
|
|
990
|
-
"
|
|
991
|
-
"GDPR compliant (if applicable)"
|
|
988
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
989
|
+
"first_party",
|
|
990
|
+
"proxied",
|
|
991
|
+
"third_party"
|
|
992
992
|
]);
|
|
993
|
-
const
|
|
994
|
-
|
|
995
|
-
"
|
|
996
|
-
"
|
|
993
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
994
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
995
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
996
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
997
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
998
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
999
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1000
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1001
|
+
"Public documentation for this connector will be live by the publish date."
|
|
997
1002
|
]);
|
|
998
1003
|
/**
|
|
999
|
-
* Field order mirrors the
|
|
1000
|
-
*
|
|
1004
|
+
* Field order mirrors the claude.ai directory submission wizard
|
|
1005
|
+
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1006
|
+
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1001
1007
|
*/
|
|
1002
1008
|
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
|
-
• Business & Productivity — project management, CRM, HR, office tools
|
|
1063
|
-
• Communication — email, chat, messaging, notifications
|
|
1064
|
-
• Data & Analytics — dashboards, reporting, databases, BI tools
|
|
1065
|
-
• Development tools — code repositories, CI/CD, issue trackers, monitoring
|
|
1066
|
-
• Financial Services — accounting, invoicing, fintech (note: financial transaction execution is not permitted)
|
|
1067
|
-
• Consumer Health — fitness, wellness, personal health tracking
|
|
1068
|
-
• Health & Life Sciences — clinical, pharma, medical professional tools
|
|
1069
|
-
• Media & Entertainment — content, publishing, streaming
|
|
1070
|
-
• Commerce & Shopping — e-commerce, inventory, orders
|
|
1071
|
-
Anthropic's submission form only accepts a single category.`),
|
|
1072
|
-
sponsoredContentsOrAdvertisement: claudeSponsoredContentSchema.describe(`Be honest here — advertising is not permitted in the Connectors Directory per Anthropic's policy. Select the option that accurately describes your server:
|
|
1073
|
-
• 'No, there is no sponsored content or advertisements' — the results your server returns are not influenced by paid placement or sponsorship. This is what almost all connectors should select.
|
|
1074
|
-
• 'Yes, there are banner ads or other paid visual elements' — your UI includes visual ads. NOTE: this will likely lead to rejection, as Anthropic prohibits advertising in Claude.
|
|
1075
|
-
• 'Yes, the returned content or ranking of returned content is impacted by sponsorship or ad placement' — paid results affect what you return. NOTE: this also likely leads to rejection.
|
|
1076
|
-
If your server returns organic results from a platform that has ads in its own UI (but your API results are not affected by ads), select 'No'.`),
|
|
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.`)
|
|
1009
|
+
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
|
|
1010
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1011
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1012
|
+
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
|
|
1013
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1014
|
+
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.
|
|
1015
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1016
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1017
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1018
|
+
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
|
|
1019
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1020
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1021
|
+
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
|
|
1022
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1023
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1024
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1025
|
+
by your publish date.`),
|
|
1026
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1027
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1028
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1029
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1030
|
+
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
|
|
1031
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1032
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1033
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1034
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1035
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1036
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1037
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1038
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1039
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1040
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1041
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1042
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1043
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1044
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1045
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1046
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1047
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1048
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1049
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1050
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1051
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1052
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1053
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1054
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1055
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1056
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1057
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1058
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1059
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1060
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1061
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1062
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1063
|
+
fully populated account.`),
|
|
1064
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1065
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1066
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1067
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1133
1068
|
});
|
|
1134
1069
|
claudeSubmissionFormDataSchema.pick({
|
|
1135
|
-
companyName: true,
|
|
1136
|
-
appName: true,
|
|
1137
|
-
mcpUrlType: true,
|
|
1138
1070
|
serverUrl: true,
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
transportSupport: true,
|
|
1071
|
+
name: true,
|
|
1072
|
+
slug: true,
|
|
1073
|
+
companyName: true,
|
|
1143
1074
|
primaryContactEmail: true,
|
|
1144
1075
|
primaryContactName: true,
|
|
1076
|
+
readWriteCapabilities: true,
|
|
1145
1077
|
authentication: true,
|
|
1146
|
-
|
|
1147
|
-
|
|
1078
|
+
apiOwnership: true,
|
|
1079
|
+
personalHealthData: true
|
|
1148
1080
|
}).extend({
|
|
1149
1081
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1150
|
-
|
|
1082
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1083
|
+
});
|
|
1084
|
+
/**
|
|
1085
|
+
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1086
|
+
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1087
|
+
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1088
|
+
* colocated with the Claude contract.
|
|
1089
|
+
*/
|
|
1090
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1091
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1092
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1093
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1094
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1095
|
+
});
|
|
1096
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1097
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1098
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1151
1099
|
});
|
|
1152
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1153
|
-
tagline: true,
|
|
1154
|
-
description: true,
|
|
1155
|
-
category: true,
|
|
1156
|
-
testCases: true
|
|
1157
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
1158
1100
|
const submissionMetaFieldsSchema = z.object({
|
|
1159
1101
|
id: z.string(),
|
|
1160
1102
|
environmentId: z.string(),
|
|
1103
|
+
auditId: z.string().nullable(),
|
|
1161
1104
|
createdAt: z.coerce.date(),
|
|
1162
1105
|
updatedAt: z.coerce.date()
|
|
1163
1106
|
});
|
|
@@ -1194,6 +1137,12 @@ z.object({
|
|
|
1194
1137
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1195
1138
|
});
|
|
1196
1139
|
//#endregion
|
|
1140
|
+
//#region src/auth-scope.ts
|
|
1141
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1142
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1143
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1144
|
+
const AUTH_SCOPE_USER = "user";
|
|
1145
|
+
//#endregion
|
|
1197
1146
|
//#region src/schemas.ts
|
|
1198
1147
|
const RESERVED_KEYS = [
|
|
1199
1148
|
"_HANDLER",
|
|
@@ -1422,7 +1371,8 @@ const createProjectContractV1 = oc.route({
|
|
|
1422
1371
|
successDescription: "The project has been created successfully"
|
|
1423
1372
|
}).errors({
|
|
1424
1373
|
NOT_FOUND: {},
|
|
1425
|
-
BAD_REQUEST: {}
|
|
1374
|
+
BAD_REQUEST: {},
|
|
1375
|
+
FORBIDDEN: {}
|
|
1426
1376
|
}).input(z.object({
|
|
1427
1377
|
teamId: z.string().optional(),
|
|
1428
1378
|
name: z.string().trim().min(1).max(100),
|
|
@@ -1528,7 +1478,8 @@ const updateProjectContractV1 = oc.route({
|
|
|
1528
1478
|
successDescription: "The project has been updated successfully"
|
|
1529
1479
|
}).errors({
|
|
1530
1480
|
NOT_FOUND: {},
|
|
1531
|
-
BAD_REQUEST: {}
|
|
1481
|
+
BAD_REQUEST: {},
|
|
1482
|
+
FORBIDDEN: {}
|
|
1532
1483
|
}).input(z.object({
|
|
1533
1484
|
projectId: z.string().describe("The ID of the project"),
|
|
1534
1485
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
@@ -1731,7 +1682,7 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1731
1682
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1732
1683
|
tags: ["tunnels"],
|
|
1733
1684
|
successDescription: "The tunnel ticket"
|
|
1734
|
-
}).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1685
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1735
1686
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1736
1687
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1737
1688
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
@@ -1885,4 +1836,4 @@ const contract = {
|
|
|
1885
1836
|
}
|
|
1886
1837
|
};
|
|
1887
1838
|
//#endregion
|
|
1888
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
1839
|
+
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-staging.
|
|
3
|
+
"version": "0.0.0-staging.gf23a958",
|
|
4
4
|
"description": "Contract for the Alpic API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.mjs",
|
|
@@ -17,19 +17,19 @@
|
|
|
17
17
|
"author": "Alpic",
|
|
18
18
|
"license": "ISC",
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@orpc/contract": "^1.14.
|
|
20
|
+
"@orpc/contract": "^1.14.6",
|
|
21
21
|
"ms": "^2.1.3",
|
|
22
22
|
"zod": "^4.4.3"
|
|
23
23
|
},
|
|
24
24
|
"devDependencies": {
|
|
25
|
-
"@orpc/openapi": "^1.14.
|
|
26
|
-
"@orpc/zod": "^1.14.
|
|
25
|
+
"@orpc/openapi": "^1.14.6",
|
|
26
|
+
"@orpc/zod": "^1.14.6",
|
|
27
27
|
"@total-typescript/tsconfig": "^1.0.4",
|
|
28
28
|
"@types/ms": "^2.1.0",
|
|
29
29
|
"shx": "^0.4.0",
|
|
30
|
-
"tsdown": "^0.22.
|
|
30
|
+
"tsdown": "^0.22.3",
|
|
31
31
|
"typescript": "^6.0.3",
|
|
32
|
-
"vitest": "^4.1.
|
|
32
|
+
"vitest": "^4.1.9",
|
|
33
33
|
"@alpic-ai/domains": "0.0.0"
|
|
34
34
|
},
|
|
35
35
|
"scripts": {
|