@alpic-ai/api 0.0.0-dev.gf17470a → 0.0.0-dev.gf1cbef7
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 +80 -58
- package/dist/index.mjs +213 -214
- package/package.json +23 -7
package/dist/index.d.mts
CHANGED
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
|
-
import * as _$_orpc_contract0 from "@orpc/contract";
|
|
3
2
|
import { InferContractRouterInputs, InferContractRouterOutputs } from "@orpc/contract";
|
|
4
|
-
|
|
5
3
|
//#region src/api.contract.d.ts
|
|
6
4
|
type ApiContext = {
|
|
7
5
|
request: Request & {
|
|
@@ -16,7 +14,7 @@ declare const deploymentStatusSchema: z.ZodEnum<{
|
|
|
16
14
|
failed: "failed";
|
|
17
15
|
canceled: "canceled";
|
|
18
16
|
}>;
|
|
19
|
-
declare const createEnvironmentContractV1:
|
|
17
|
+
declare const createEnvironmentContractV1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
20
18
|
projectId: z.ZodString;
|
|
21
19
|
name: z.ZodString;
|
|
22
20
|
sourceBranch: z.ZodString;
|
|
@@ -32,14 +30,14 @@ declare const createEnvironmentContractV1: _$_orpc_contract0.ContractProcedureBu
|
|
|
32
30
|
urls: z.ZodArray<z.ZodURL>;
|
|
33
31
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
34
32
|
projectId: z.ZodString;
|
|
35
|
-
}, z.core.$strip>,
|
|
33
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
36
34
|
NOT_FOUND: {};
|
|
37
35
|
BAD_REQUEST: {};
|
|
38
36
|
}>, Record<never, never>>;
|
|
39
37
|
declare const contract: {
|
|
40
38
|
teams: {
|
|
41
39
|
list: {
|
|
42
|
-
v1:
|
|
40
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, z.ZodArray<z.ZodObject<{
|
|
43
41
|
id: z.ZodString;
|
|
44
42
|
name: z.ZodString;
|
|
45
43
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
@@ -49,7 +47,7 @@ declare const contract: {
|
|
|
49
47
|
};
|
|
50
48
|
analytics: {
|
|
51
49
|
get: {
|
|
52
|
-
v1:
|
|
50
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
53
51
|
projectId: z.ZodString;
|
|
54
52
|
startTimestamp: z.ZodCoercedNumber<unknown>;
|
|
55
53
|
endTimestamp: z.ZodCoercedNumber<unknown>;
|
|
@@ -92,7 +90,7 @@ declare const contract: {
|
|
|
92
90
|
categories: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
93
91
|
}, z.core.$strip>>;
|
|
94
92
|
}, z.core.$strip>;
|
|
95
|
-
}, z.core.$strip>,
|
|
93
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
96
94
|
NOT_FOUND: {};
|
|
97
95
|
BAD_REQUEST: {};
|
|
98
96
|
}>, Record<never, never>>;
|
|
@@ -100,7 +98,7 @@ declare const contract: {
|
|
|
100
98
|
};
|
|
101
99
|
deployments: {
|
|
102
100
|
list: {
|
|
103
|
-
v1:
|
|
101
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
104
102
|
projectId: z.ZodString;
|
|
105
103
|
status: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
106
104
|
ongoing: "ongoing";
|
|
@@ -128,12 +126,12 @@ declare const contract: {
|
|
|
128
126
|
environmentName: z.ZodString;
|
|
129
127
|
isCurrent: z.ZodBoolean;
|
|
130
128
|
deploymentPageUrl: z.ZodNullable<z.ZodURL>;
|
|
131
|
-
}, z.core.$strip>>,
|
|
129
|
+
}, z.core.$strip>>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
132
130
|
NOT_FOUND: {};
|
|
133
131
|
}>, Record<never, never>>;
|
|
134
132
|
};
|
|
135
133
|
get: {
|
|
136
|
-
v1:
|
|
134
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
137
135
|
deploymentId: z.ZodString;
|
|
138
136
|
}, z.core.$strip>, z.ZodObject<{
|
|
139
137
|
id: z.ZodString;
|
|
@@ -154,24 +152,24 @@ declare const contract: {
|
|
|
154
152
|
environmentName: z.ZodString;
|
|
155
153
|
isCurrent: z.ZodBoolean;
|
|
156
154
|
deploymentPageUrl: z.ZodNullable<z.ZodURL>;
|
|
157
|
-
}, z.core.$strip>,
|
|
155
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
158
156
|
NOT_FOUND: {};
|
|
159
157
|
}>, Record<never, never>>;
|
|
160
158
|
};
|
|
161
159
|
uploadArtifact: {
|
|
162
|
-
v1:
|
|
160
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodOptional<z.ZodObject<{
|
|
163
161
|
teamId: z.ZodOptional<z.ZodString>;
|
|
164
162
|
}, z.core.$strip>>, z.ZodObject<{
|
|
165
163
|
uploadUrl: z.ZodURL;
|
|
166
164
|
token: z.ZodString;
|
|
167
165
|
expiresAt: z.ZodCoercedDate<unknown>;
|
|
168
|
-
}, z.core.$strip>,
|
|
166
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
169
167
|
NOT_FOUND: {};
|
|
170
168
|
BAD_REQUEST: {};
|
|
171
169
|
}>, Record<never, never>>;
|
|
172
170
|
};
|
|
173
171
|
getLogs: {
|
|
174
|
-
v1:
|
|
172
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
175
173
|
deploymentId: z.ZodString;
|
|
176
174
|
}, z.core.$strip>, z.ZodObject<{
|
|
177
175
|
logs: z.ZodArray<z.ZodObject<{
|
|
@@ -179,14 +177,14 @@ declare const contract: {
|
|
|
179
177
|
content: z.ZodOptional<z.ZodString>;
|
|
180
178
|
}, z.core.$strip>>;
|
|
181
179
|
hasMoreLogs: z.ZodBoolean;
|
|
182
|
-
}, z.core.$strip>,
|
|
180
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
183
181
|
NOT_FOUND: {};
|
|
184
182
|
}>, Record<never, never>>;
|
|
185
183
|
};
|
|
186
184
|
};
|
|
187
185
|
environments: {
|
|
188
186
|
create: {
|
|
189
|
-
v1:
|
|
187
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
190
188
|
projectId: z.ZodString;
|
|
191
189
|
name: z.ZodString;
|
|
192
190
|
sourceBranch: z.ZodString;
|
|
@@ -202,13 +200,13 @@ declare const contract: {
|
|
|
202
200
|
urls: z.ZodArray<z.ZodURL>;
|
|
203
201
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
204
202
|
projectId: z.ZodString;
|
|
205
|
-
}, z.core.$strip>,
|
|
203
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
206
204
|
NOT_FOUND: {};
|
|
207
205
|
BAD_REQUEST: {};
|
|
208
206
|
}>, Record<never, never>>;
|
|
209
207
|
};
|
|
210
208
|
get: {
|
|
211
|
-
v1:
|
|
209
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
212
210
|
environmentId: z.ZodString;
|
|
213
211
|
}, z.core.$strip>, z.ZodObject<{
|
|
214
212
|
id: z.ZodString;
|
|
@@ -218,14 +216,25 @@ declare const contract: {
|
|
|
218
216
|
domains: z.ZodArray<z.ZodCustomStringFormat<"hostname">>;
|
|
219
217
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
220
218
|
projectId: z.ZodString;
|
|
221
|
-
}, z.core.$strip>,
|
|
219
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
222
220
|
NOT_FOUND: {};
|
|
223
221
|
}>, Record<never, never>>;
|
|
224
222
|
};
|
|
225
223
|
deploy: {
|
|
226
|
-
v1:
|
|
224
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
227
225
|
environmentId: z.ZodString;
|
|
228
226
|
token: z.ZodOptional<z.ZodString>;
|
|
227
|
+
settings: z.ZodOptional<z.ZodObject<{
|
|
228
|
+
installCommand: z.ZodOptional<z.ZodString>;
|
|
229
|
+
buildCommand: z.ZodOptional<z.ZodString>;
|
|
230
|
+
buildOutputDir: z.ZodOptional<z.ZodString>;
|
|
231
|
+
startCommand: z.ZodOptional<z.ZodString>;
|
|
232
|
+
transport: z.ZodEnum<{
|
|
233
|
+
stdio: "stdio";
|
|
234
|
+
sse: "sse";
|
|
235
|
+
streamablehttp: "streamablehttp";
|
|
236
|
+
}>;
|
|
237
|
+
}, z.core.$strip>>;
|
|
229
238
|
}, z.core.$strip>, z.ZodObject<{
|
|
230
239
|
id: z.ZodString;
|
|
231
240
|
status: z.ZodEnum<{
|
|
@@ -245,13 +254,13 @@ declare const contract: {
|
|
|
245
254
|
environmentName: z.ZodString;
|
|
246
255
|
isCurrent: z.ZodBoolean;
|
|
247
256
|
deploymentPageUrl: z.ZodNullable<z.ZodURL>;
|
|
248
|
-
}, z.core.$strip>,
|
|
257
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
249
258
|
NOT_FOUND: {};
|
|
250
259
|
BAD_REQUEST: {};
|
|
251
260
|
}>, Record<never, never>>;
|
|
252
261
|
};
|
|
253
262
|
getLogs: {
|
|
254
|
-
v1:
|
|
263
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
255
264
|
environmentId: z.ZodString;
|
|
256
265
|
since: z.ZodOptional<z.ZodString>;
|
|
257
266
|
until: z.ZodOptional<z.ZodString>;
|
|
@@ -281,13 +290,13 @@ declare const contract: {
|
|
|
281
290
|
durationInMs: z.ZodOptional<z.ZodNumber>;
|
|
282
291
|
}, z.core.$strip>>;
|
|
283
292
|
nextToken: z.ZodNullable<z.ZodString>;
|
|
284
|
-
}, z.core.$strip>,
|
|
293
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
285
294
|
NOT_FOUND: {};
|
|
286
295
|
BAD_REQUEST: {};
|
|
287
296
|
}>, Record<never, never>>;
|
|
288
297
|
};
|
|
289
298
|
getLatestLogs: {
|
|
290
|
-
v1:
|
|
299
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
291
300
|
environmentId: z.ZodString;
|
|
292
301
|
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
293
302
|
level: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
@@ -313,7 +322,7 @@ declare const contract: {
|
|
|
313
322
|
method: z.ZodOptional<z.ZodString>;
|
|
314
323
|
durationInMs: z.ZodOptional<z.ZodNumber>;
|
|
315
324
|
}, z.core.$strip>>;
|
|
316
|
-
}, z.core.$strip>,
|
|
325
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
317
326
|
NOT_FOUND: {};
|
|
318
327
|
BAD_REQUEST: {};
|
|
319
328
|
}>, Record<never, never>>;
|
|
@@ -321,7 +330,7 @@ declare const contract: {
|
|
|
321
330
|
};
|
|
322
331
|
environmentVariables: {
|
|
323
332
|
list: {
|
|
324
|
-
v1:
|
|
333
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
325
334
|
environmentId: z.ZodString;
|
|
326
335
|
}, z.core.$strip>, z.ZodArray<z.ZodObject<{
|
|
327
336
|
id: z.ZodString;
|
|
@@ -329,12 +338,12 @@ declare const contract: {
|
|
|
329
338
|
value: z.ZodString;
|
|
330
339
|
isSecret: z.ZodBoolean;
|
|
331
340
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
332
|
-
}, z.core.$strip>>,
|
|
341
|
+
}, z.core.$strip>>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
333
342
|
NOT_FOUND: {};
|
|
334
343
|
}>, Record<never, never>>;
|
|
335
344
|
};
|
|
336
345
|
create: {
|
|
337
|
-
v1:
|
|
346
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
338
347
|
environmentId: z.ZodString;
|
|
339
348
|
environmentVariables: z.ZodArray<z.ZodObject<{
|
|
340
349
|
key: z.ZodString;
|
|
@@ -343,30 +352,30 @@ declare const contract: {
|
|
|
343
352
|
}, z.core.$strip>>;
|
|
344
353
|
}, z.core.$strip>, z.ZodObject<{
|
|
345
354
|
success: z.ZodLiteral<true>;
|
|
346
|
-
}, z.core.$strip>,
|
|
355
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
347
356
|
NOT_FOUND: {};
|
|
348
357
|
BAD_REQUEST: {};
|
|
349
358
|
}>, Record<never, never>>;
|
|
350
359
|
};
|
|
351
360
|
update: {
|
|
352
|
-
v1:
|
|
361
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
353
362
|
environmentVariableId: z.ZodString;
|
|
354
363
|
key: z.ZodString;
|
|
355
364
|
value: z.ZodOptional<z.ZodString>;
|
|
356
365
|
isSecret: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
357
366
|
}, z.core.$strip>, z.ZodObject<{
|
|
358
367
|
success: z.ZodLiteral<true>;
|
|
359
|
-
}, z.core.$strip>,
|
|
368
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
360
369
|
NOT_FOUND: {};
|
|
361
370
|
BAD_REQUEST: {};
|
|
362
371
|
}>, Record<never, never>>;
|
|
363
372
|
};
|
|
364
373
|
delete: {
|
|
365
|
-
v1:
|
|
374
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
366
375
|
environmentVariableId: z.ZodString;
|
|
367
376
|
}, z.core.$strip>, z.ZodObject<{
|
|
368
377
|
success: z.ZodLiteral<true>;
|
|
369
|
-
}, z.core.$strip>,
|
|
378
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
370
379
|
NOT_FOUND: {};
|
|
371
380
|
BAD_REQUEST: {};
|
|
372
381
|
}>, Record<never, never>>;
|
|
@@ -374,7 +383,7 @@ declare const contract: {
|
|
|
374
383
|
};
|
|
375
384
|
projects: {
|
|
376
385
|
update: {
|
|
377
|
-
v1:
|
|
386
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
378
387
|
projectId: z.ZodString;
|
|
379
388
|
name: z.ZodOptional<z.ZodString>;
|
|
380
389
|
sourceRepository: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
@@ -446,13 +455,14 @@ declare const contract: {
|
|
|
446
455
|
completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
|
|
447
456
|
}, z.core.$strip>>;
|
|
448
457
|
}, z.core.$strip>>;
|
|
449
|
-
}, z.core.$strip>,
|
|
458
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
450
459
|
NOT_FOUND: {};
|
|
451
460
|
BAD_REQUEST: {};
|
|
461
|
+
FORBIDDEN: {};
|
|
452
462
|
}>, Record<never, never>>;
|
|
453
463
|
};
|
|
454
464
|
get: {
|
|
455
|
-
v1:
|
|
465
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
456
466
|
projectId: z.ZodString;
|
|
457
467
|
}, z.core.$strip>, z.ZodObject<{
|
|
458
468
|
id: z.ZodString;
|
|
@@ -522,12 +532,12 @@ declare const contract: {
|
|
|
522
532
|
completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
|
|
523
533
|
}, z.core.$strip>>;
|
|
524
534
|
}, z.core.$strip>>;
|
|
525
|
-
}, z.core.$strip>,
|
|
535
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
526
536
|
NOT_FOUND: {};
|
|
527
537
|
}>, Record<never, never>>;
|
|
528
538
|
};
|
|
529
539
|
list: {
|
|
530
|
-
v1:
|
|
540
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodOptional<z.ZodObject<{
|
|
531
541
|
teamId: z.ZodOptional<z.ZodString>;
|
|
532
542
|
}, z.core.$strip>>, z.ZodArray<z.ZodObject<{
|
|
533
543
|
id: z.ZodString;
|
|
@@ -597,13 +607,13 @@ declare const contract: {
|
|
|
597
607
|
completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
|
|
598
608
|
}, z.core.$strip>>;
|
|
599
609
|
}, z.core.$strip>>;
|
|
600
|
-
}, z.core.$strip>>,
|
|
610
|
+
}, z.core.$strip>>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
601
611
|
NOT_FOUND: {};
|
|
602
612
|
BAD_REQUEST: {};
|
|
603
613
|
}>, Record<never, never>>;
|
|
604
614
|
};
|
|
605
615
|
create: {
|
|
606
|
-
v1:
|
|
616
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
607
617
|
teamId: z.ZodOptional<z.ZodString>;
|
|
608
618
|
name: z.ZodString;
|
|
609
619
|
sourceRepository: z.ZodOptional<z.ZodString>;
|
|
@@ -661,24 +671,25 @@ declare const contract: {
|
|
|
661
671
|
installCommand: z.ZodNullable<z.ZodString>;
|
|
662
672
|
startCommand: z.ZodNullable<z.ZodString>;
|
|
663
673
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
664
|
-
}, z.core.$strip>,
|
|
674
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
665
675
|
NOT_FOUND: {};
|
|
666
676
|
BAD_REQUEST: {};
|
|
677
|
+
FORBIDDEN: {};
|
|
667
678
|
}>, Record<never, never>>;
|
|
668
679
|
};
|
|
669
680
|
delete: {
|
|
670
|
-
v1:
|
|
681
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
671
682
|
projectId: z.ZodString;
|
|
672
683
|
}, z.core.$strip>, z.ZodObject<{
|
|
673
684
|
success: z.ZodLiteral<true>;
|
|
674
|
-
}, z.core.$strip>,
|
|
685
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
675
686
|
NOT_FOUND: {};
|
|
676
687
|
}>, Record<never, never>>;
|
|
677
688
|
};
|
|
678
689
|
};
|
|
679
690
|
playground: {
|
|
680
691
|
get: {
|
|
681
|
-
v1:
|
|
692
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
682
693
|
environmentId: z.ZodString;
|
|
683
694
|
}, z.core.$strip>, z.ZodObject<{
|
|
684
695
|
isPlaygroundEnabled: z.ZodBoolean;
|
|
@@ -696,12 +707,12 @@ declare const contract: {
|
|
|
696
707
|
prompt: z.ZodString;
|
|
697
708
|
}, z.core.$strip>>;
|
|
698
709
|
}, z.core.$strip>>;
|
|
699
|
-
}, z.core.$strip>,
|
|
710
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
700
711
|
NOT_FOUND: {};
|
|
701
712
|
}>, Record<never, never>>;
|
|
702
713
|
};
|
|
703
714
|
upsert: {
|
|
704
|
-
v1:
|
|
715
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
705
716
|
environmentId: z.ZodString;
|
|
706
717
|
isPlaygroundEnabled: z.ZodOptional<z.ZodBoolean>;
|
|
707
718
|
name: z.ZodOptional<z.ZodString>;
|
|
@@ -732,7 +743,7 @@ declare const contract: {
|
|
|
732
743
|
prompt: z.ZodString;
|
|
733
744
|
}, z.core.$strip>>;
|
|
734
745
|
}, z.core.$strip>>;
|
|
735
|
-
}, z.core.$strip>,
|
|
746
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
736
747
|
NOT_FOUND: {};
|
|
737
748
|
BAD_REQUEST: {};
|
|
738
749
|
}>, Record<never, never>>;
|
|
@@ -740,18 +751,18 @@ declare const contract: {
|
|
|
740
751
|
};
|
|
741
752
|
tunnels: {
|
|
742
753
|
getTicket: {
|
|
743
|
-
v1:
|
|
754
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, z.ZodObject<{
|
|
744
755
|
subdomain: z.ZodString;
|
|
745
756
|
ticket: z.ZodString;
|
|
746
757
|
tunnelHost: z.ZodString;
|
|
747
|
-
}, z.core.$strip>,
|
|
758
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
748
759
|
FORBIDDEN: {};
|
|
749
760
|
}>, Record<never, never>>;
|
|
750
761
|
};
|
|
751
762
|
};
|
|
752
763
|
distribution: {
|
|
753
764
|
publish: {
|
|
754
|
-
v1:
|
|
765
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
755
766
|
projectId: z.ZodString;
|
|
756
767
|
domain: z.ZodString;
|
|
757
768
|
title: z.ZodString;
|
|
@@ -783,13 +794,13 @@ declare const contract: {
|
|
|
783
794
|
}, z.core.$strip>>>;
|
|
784
795
|
}, z.core.$strip>>>;
|
|
785
796
|
}, z.core.$strip>;
|
|
786
|
-
}, z.core.$strip>,
|
|
797
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
787
798
|
NOT_FOUND: {};
|
|
788
799
|
BAD_REQUEST: {};
|
|
789
800
|
}>, Record<never, never>>;
|
|
790
801
|
};
|
|
791
802
|
get: {
|
|
792
|
-
v1:
|
|
803
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
793
804
|
projectId: z.ZodString;
|
|
794
805
|
domain: z.ZodString;
|
|
795
806
|
}, z.core.$strip>, z.ZodObject<{
|
|
@@ -816,7 +827,7 @@ declare const contract: {
|
|
|
816
827
|
}, z.core.$strip>>>;
|
|
817
828
|
}, z.core.$strip>>>;
|
|
818
829
|
}, z.core.$strip>;
|
|
819
|
-
}, z.core.$strip>,
|
|
830
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
820
831
|
NOT_FOUND: {};
|
|
821
832
|
BAD_REQUEST: {};
|
|
822
833
|
}>, Record<never, never>>;
|
|
@@ -824,7 +835,7 @@ declare const contract: {
|
|
|
824
835
|
};
|
|
825
836
|
beacon: {
|
|
826
837
|
create: {
|
|
827
|
-
v1:
|
|
838
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
828
839
|
targetUrl: z.ZodURL;
|
|
829
840
|
teamId: z.ZodOptional<z.ZodString>;
|
|
830
841
|
projectId: z.ZodOptional<z.ZodString>;
|
|
@@ -837,7 +848,7 @@ declare const contract: {
|
|
|
837
848
|
}>>>;
|
|
838
849
|
}, z.core.$strip>, z.ZodObject<{
|
|
839
850
|
id: z.ZodString;
|
|
840
|
-
}, z.core.$strip>,
|
|
851
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
841
852
|
NOT_FOUND: {};
|
|
842
853
|
BAD_REQUEST: {};
|
|
843
854
|
DNS_RESOLUTION_FAILED: {
|
|
@@ -846,7 +857,7 @@ declare const contract: {
|
|
|
846
857
|
}>, Record<never, never>>;
|
|
847
858
|
};
|
|
848
859
|
get: {
|
|
849
|
-
v1:
|
|
860
|
+
v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
850
861
|
auditId: z.ZodString;
|
|
851
862
|
}, z.core.$strip>, z.ZodObject<{
|
|
852
863
|
id: z.ZodString;
|
|
@@ -930,7 +941,7 @@ declare const contract: {
|
|
|
930
941
|
}, z.core.$strip>>;
|
|
931
942
|
}, z.core.$strip>;
|
|
932
943
|
}, z.core.$strip>>;
|
|
933
|
-
}, z.core.$strip>,
|
|
944
|
+
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
934
945
|
NOT_FOUND: {};
|
|
935
946
|
}>, Record<never, never>>;
|
|
936
947
|
};
|
|
@@ -939,6 +950,17 @@ declare const contract: {
|
|
|
939
950
|
type RouterInput = InferContractRouterInputs<typeof contract>;
|
|
940
951
|
type RouterOutput = InferContractRouterOutputs<typeof contract>;
|
|
941
952
|
//#endregion
|
|
953
|
+
//#region src/auth-scope.d.ts
|
|
954
|
+
/** Credential scope required by an API route. */
|
|
955
|
+
type AuthScope = "any" | "user";
|
|
956
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
957
|
+
declare const AUTH_SCOPE_ANY = "any";
|
|
958
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
959
|
+
declare const AUTH_SCOPE_USER = "user";
|
|
960
|
+
type RouteAuthMeta = {
|
|
961
|
+
authScope?: AuthScope;
|
|
962
|
+
};
|
|
963
|
+
//#endregion
|
|
942
964
|
//#region ../domains/src/platforms/schemas.d.ts
|
|
943
965
|
declare const platformSchema: z.ZodEnum<{
|
|
944
966
|
chatgpt: "chatgpt";
|
|
@@ -1018,4 +1040,4 @@ declare const serverFieldsSchema: z.ZodObject<{
|
|
|
1018
1040
|
}, z.core.$strip>>>;
|
|
1019
1041
|
}, z.core.$strip>;
|
|
1020
1042
|
//#endregion
|
|
1021
|
-
export { ApiContext, PLATFORM_LABELS, type Platform, RouterInput, RouterOutput, Runtime, Transport, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
1043
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, ApiContext, AuthScope, PLATFORM_LABELS, type Platform, RouteAuthMeta, RouterInput, RouterOutput, Runtime, Transport, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
package/dist/index.mjs
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
import * as z$1 from "zod/v4";
|
|
3
3
|
import { oc } from "@orpc/contract";
|
|
4
4
|
import ms from "ms";
|
|
5
|
-
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.29.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.29.0_zod@4.4.3/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -342,8 +342,14 @@ z.union([
|
|
|
342
342
|
protectedWithoutDiscoveryEnvironmentSchema
|
|
343
343
|
]);
|
|
344
344
|
const allowedPlatformSchema = platformSchema;
|
|
345
|
+
const playgroundModelSchema = z.enum([
|
|
346
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
347
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
348
|
+
"openai.gpt-5.4",
|
|
349
|
+
"openai.gpt-5.5"
|
|
350
|
+
]);
|
|
345
351
|
const environmentDomainSchema = z.object({
|
|
346
|
-
|
|
352
|
+
name: z.string(),
|
|
347
353
|
status: z.enum([
|
|
348
354
|
"ongoing",
|
|
349
355
|
"deployed",
|
|
@@ -361,6 +367,7 @@ const environmentSchema$1 = z.object({
|
|
|
361
367
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
362
368
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
363
369
|
isPlaygroundEnabled: z.boolean(),
|
|
370
|
+
playgroundModel: playgroundModelSchema,
|
|
364
371
|
isIpWhitelistEnabled: z.boolean(),
|
|
365
372
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
366
373
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -369,6 +376,13 @@ const environmentSchema$1 = z.object({
|
|
|
369
376
|
updatedAt: z.coerce.date()
|
|
370
377
|
});
|
|
371
378
|
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
379
|
+
z.object({
|
|
380
|
+
sessionReplayEnabled: z.boolean(),
|
|
381
|
+
collectRequestPayload: z.boolean(),
|
|
382
|
+
collectResponsePayload: z.boolean(),
|
|
383
|
+
collectErrorMessage: z.boolean(),
|
|
384
|
+
collectUserData: z.boolean()
|
|
385
|
+
});
|
|
372
386
|
z.object({
|
|
373
387
|
id: z.string(),
|
|
374
388
|
createdAt: z.coerce.date(),
|
|
@@ -502,15 +516,27 @@ z.object({
|
|
|
502
516
|
environments: z.array(environmentWithDomainsSchema),
|
|
503
517
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
504
518
|
});
|
|
519
|
+
const domainFailureReasonSchema = z.enum([
|
|
520
|
+
"caa",
|
|
521
|
+
"dns",
|
|
522
|
+
"invalid_domain",
|
|
523
|
+
"other"
|
|
524
|
+
]);
|
|
525
|
+
const projectDomainMappingSchema = z.object({
|
|
526
|
+
pathPrefix: z.string(),
|
|
527
|
+
environment: environmentSchema$1
|
|
528
|
+
});
|
|
505
529
|
z.object({
|
|
506
|
-
|
|
530
|
+
name: z.string(),
|
|
507
531
|
createdAt: z.coerce.date(),
|
|
508
532
|
status: z.enum([
|
|
509
533
|
"ongoing",
|
|
510
534
|
"deployed",
|
|
511
535
|
"failed"
|
|
512
536
|
]),
|
|
513
|
-
|
|
537
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
538
|
+
environment: environmentSchema$1,
|
|
539
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
514
540
|
});
|
|
515
541
|
const serverFieldsSchema$1 = z.object({
|
|
516
542
|
$schema: z.string(),
|
|
@@ -567,17 +593,20 @@ const toolDefinitionSchema = z.object({
|
|
|
567
593
|
}).optional()
|
|
568
594
|
});
|
|
569
595
|
const positiveTestCaseSchema = z.object({
|
|
570
|
-
scenario: z.string(),
|
|
571
|
-
userPrompt: z.string(),
|
|
572
|
-
toolTriggered: z.string().optional(),
|
|
573
|
-
expectedOutput: z.string().optional()
|
|
596
|
+
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
597
|
+
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."),
|
|
598
|
+
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
599
|
+
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
574
600
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
575
601
|
const screenshotEntrySchema = z.object({
|
|
576
602
|
prompt: z.string(),
|
|
577
|
-
url: z.url()
|
|
603
|
+
url: z.url()
|
|
578
604
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
605
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
579
606
|
/** Accepts either a valid email or URL. */
|
|
580
607
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
608
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
609
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
581
610
|
const chatgptCategorySchema = z.enum([
|
|
582
611
|
"BUSINESS",
|
|
583
612
|
"COLLABORATION",
|
|
@@ -886,10 +915,10 @@ const negativeTestCaseSchema = z.object({
|
|
|
886
915
|
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
887
916
|
const chatgptToolJustificationSchema = z.object({
|
|
888
917
|
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).");
|
|
918
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
919
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
920
|
+
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.\"")
|
|
921
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
893
922
|
/**
|
|
894
923
|
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
895
924
|
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
@@ -911,27 +940,38 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
911
940
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
912
941
|
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
942
|
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."),
|
|
943
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
944
|
+
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
945
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
917
946
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
918
|
-
companyUrl:
|
|
947
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
919
948
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
920
|
-
privacyPolicyUrl:
|
|
921
|
-
termsOfServiceUrl:
|
|
922
|
-
demoRecordingUrl:
|
|
949
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
950
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
951
|
+
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
952
|
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:
|
|
953
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
925
954
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
926
955
|
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
|
|
956
|
+
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."),
|
|
957
|
+
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."),
|
|
958
|
+
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."),
|
|
959
|
+
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
960
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
932
961
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
933
962
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
934
963
|
});
|
|
964
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
965
|
+
tagline: z.string().optional(),
|
|
966
|
+
companyUrl: z.string().optional(),
|
|
967
|
+
supportChannel: z.string().optional(),
|
|
968
|
+
privacyPolicyUrl: z.string().optional(),
|
|
969
|
+
termsOfServiceUrl: z.string().optional(),
|
|
970
|
+
demoRecordingUrl: z.string().optional(),
|
|
971
|
+
serverUrl: z.string().optional(),
|
|
972
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
973
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
974
|
+
});
|
|
935
975
|
chatgptSubmissionFormDataSchema.pick({
|
|
936
976
|
appName: true,
|
|
937
977
|
developerName: true,
|
|
@@ -948,7 +988,7 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
948
988
|
toolJustifications: true
|
|
949
989
|
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
950
990
|
const claudeCategorySchema = z.enum([
|
|
951
|
-
"
|
|
991
|
+
"Productivity",
|
|
952
992
|
"Communication",
|
|
953
993
|
"Data & Analytics",
|
|
954
994
|
"Development tools",
|
|
@@ -956,221 +996,171 @@ const claudeCategorySchema = z.enum([
|
|
|
956
996
|
"Consumer Health",
|
|
957
997
|
"Health & Life Sciences",
|
|
958
998
|
"Media & Entertainment",
|
|
959
|
-
"Commerce & Shopping"
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
"
|
|
963
|
-
"
|
|
964
|
-
"
|
|
999
|
+
"Commerce & Shopping",
|
|
1000
|
+
"Legal",
|
|
1001
|
+
"Sales and marketing",
|
|
1002
|
+
"Creative",
|
|
1003
|
+
"Nonprofit",
|
|
1004
|
+
"Education",
|
|
1005
|
+
"Other"
|
|
965
1006
|
]);
|
|
966
|
-
const
|
|
967
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1007
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
968
1008
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
969
|
-
"
|
|
970
|
-
"
|
|
971
|
-
"
|
|
1009
|
+
"read_only",
|
|
1010
|
+
"write_only",
|
|
1011
|
+
"read_write"
|
|
972
1012
|
]);
|
|
973
|
-
const
|
|
974
|
-
|
|
975
|
-
"
|
|
976
|
-
"
|
|
977
|
-
"
|
|
978
|
-
"
|
|
979
|
-
]);
|
|
980
|
-
const claudeThirdPartySchema = z.enum([
|
|
981
|
-
"Web access: Fetches information from the open web (e.g., web scraping, search engines, or browsing arbitrary URLs, not just connecting to a specific API)",
|
|
982
|
-
"Third-party AI model integration: Sends data to or receives data from a generative AI model other than Claude",
|
|
983
|
-
"Third-party data retrieval: Connects to external services that themselves retrieve data from other sources (e.g., workflow automation platforms or other services that aggregate or relay data from multiple third-party sources)",
|
|
984
|
-
"Third-party data modification: Can connect to external services that themselves create, update, or delete data in other sources (e.g., workflow automation platforms or other services that write to multiple third-party sources)",
|
|
985
|
-
"N/A"
|
|
1013
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1014
|
+
"oauth_dcr",
|
|
1015
|
+
"oauth_cimd",
|
|
1016
|
+
"oauth_anthropic_creds",
|
|
1017
|
+
"custom_connection",
|
|
1018
|
+
"none"
|
|
986
1019
|
]);
|
|
987
|
-
const
|
|
988
|
-
"
|
|
989
|
-
"
|
|
990
|
-
"
|
|
991
|
-
"GDPR compliant (if applicable)"
|
|
1020
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1021
|
+
"first_party",
|
|
1022
|
+
"proxied",
|
|
1023
|
+
"third_party"
|
|
992
1024
|
]);
|
|
993
|
-
const
|
|
994
|
-
|
|
995
|
-
"
|
|
996
|
-
"
|
|
1025
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1026
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1027
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1028
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1029
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1030
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1031
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1032
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1033
|
+
"Public documentation for this connector will be live by the publish date."
|
|
997
1034
|
]);
|
|
998
1035
|
/**
|
|
999
|
-
* Field order mirrors the
|
|
1000
|
-
*
|
|
1036
|
+
* Field order mirrors the claude.ai directory submission wizard
|
|
1037
|
+
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1038
|
+
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1001
1039
|
*/
|
|
1002
1040
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
(
|
|
1013
|
-
|
|
1014
|
-
(
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
•
|
|
1032
|
-
•
|
|
1033
|
-
•
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
• '
|
|
1049
|
-
• '
|
|
1050
|
-
• '
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
|
|
1078
|
-
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
1079
|
-
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
1080
|
-
• 'SSE (Server-Sent Events)' — the older transport. SSE may be deprecated by Anthropic later in 2025/2026. If you currently only support SSE, you should plan to migrate to Streamable HTTP.
|
|
1081
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
1082
|
-
serverDocumentationLink: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. This is displayed in the Directory listing and must be publicly accessible without login. Minimum requirements for the docs page:
|
|
1083
|
-
• What the connector does and its key capabilities
|
|
1084
|
-
• How to connect/set it up (step by step)
|
|
1085
|
-
• What each tool does (or at least the main ones)
|
|
1086
|
-
• How to troubleshoot common issues
|
|
1087
|
-
• A support contact or channel
|
|
1088
|
-
Acceptable formats: a dedicated docs page, a help center article, a README on GitHub, or a blog post — as long as it's comprehensive. Note: Anthropic requires public documentation to be live by your publish date.`),
|
|
1089
|
-
privacyPolicyUrl: z.url().describe(`URL to your privacy policy. This is mandatory and displayed in the directory listing. Missing or incomplete privacy policies result in immediate rejection. Your privacy policy must cover:
|
|
1090
|
-
• What data you collect (and how)
|
|
1091
|
-
• How you use the collected data
|
|
1092
|
-
• Where and how long you store it
|
|
1093
|
-
• Whether you share data with third parties (and who)
|
|
1094
|
-
• How users can contact you about data concerns
|
|
1095
|
-
The policy must be publicly accessible. If you don't have one yet, create one before submitting — there are free generators online, but make sure it accurately reflects your actual practices. If you're GDPR-compliant, your policy should reflect that.`),
|
|
1096
|
-
supportChannel: supportChannelSchema.describe(`A URL or email address where users can get help with your connector. This is displayed in the Directory listing. Acceptable options:
|
|
1097
|
-
• Email address (e.g. support@myapp.com)
|
|
1098
|
-
• Link to a GitHub Issues page
|
|
1099
|
-
• Link to a help center or support article
|
|
1100
|
-
• Link to a Discord/Slack community
|
|
1101
|
-
• Link to your documentation's troubleshooting section
|
|
1102
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1103
|
-
testingCredentials: z.string().describe(`Provide login credentials for a test account that Anthropic reviewers can use to verify your server works end-to-end. Critical requirements:
|
|
1104
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
1105
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
1106
|
-
• If your service uses Google OAuth or another OAuth that requires email verification, use mcp-review@anthropic.com as the account email — Anthropic has access to this inbox.
|
|
1107
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
1108
|
-
• If your service requires API keys instead of a password, provide those.
|
|
1109
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
1110
|
-
tools: z.array(toolDefinitionSchema).describe(`A comma-separated list of all tools your MCP server exposes. Use the format: tool_name (Human-Readable Name). The tool_name is the internal identifier (snake_case, max 64 characters). The Human-Readable Name is what users see.
|
|
1111
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
1112
|
-
Reviewers test every single tool you list here — don't list tools that don't work. Also: do not have a single catch-all tool like api_request(method, endpoint) — Anthropic rejects these. Each action should be its own purpose-built tool.`),
|
|
1113
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
1114
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
1115
|
-
• 'I've specified accurate tool annotations for all tools' — every tool has the correct annotation: readOnlyHint: true for read operations (search, get, list, fetch), OR destructiveHint: true for write operations (create, update, delete, send).
|
|
1116
|
-
This is the #1 reason submissions get rejected (30% of all rejections). Do not check these boxes without actually having implemented the annotations. See MCP spec for how to add them.`),
|
|
1117
|
-
testedSurfaces: z.array(claudeTestedSurfaceSchema).describe(`Confirm testing is complete and your server works as intended in these surfaces. Select every surface you've verified. Claude.ai (web) and Claude Desktop are the usual targets for remote MCP servers; Claude Code and Cowork compatibility is not required. Anthropic requires at least two surfaces.`),
|
|
1118
|
-
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
1119
|
-
• Format: SVG only
|
|
1120
|
-
• Aspect ratio: square (1:1)
|
|
1121
|
-
• Should work on a light background
|
|
1122
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
1123
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
1124
|
-
logoDark: z.string().optional().describe(`Optional dark-mode variant of the connector logo. Same specs as the light variant (SVG, square 1:1) but designed to read on a dark background. Leave empty if the light logo already works on dark.`),
|
|
1125
|
-
screenshots: z.array(screenshotEntrySchema).describe(`Screenshots or promotional images of your connector in action within Claude. Strongly recommended for all connectors, and required for MCP Apps (interactive UI). Guidelines:
|
|
1126
|
-
• 3–5 images is ideal
|
|
1127
|
-
• Minimum 1000px width, PNG format preferred
|
|
1128
|
-
• Each screenshot is paired with the user prompt that produced it
|
|
1129
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
1130
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
1131
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
1132
|
-
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
1041
|
+
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
|
|
1042
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1043
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1044
|
+
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
|
|
1045
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1046
|
+
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.
|
|
1047
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1048
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1049
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1050
|
+
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
|
|
1051
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1052
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1053
|
+
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
|
|
1054
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1055
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1056
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1057
|
+
by your publish date.`),
|
|
1058
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1059
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1060
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1061
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1062
|
+
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
|
|
1063
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1064
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1065
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1066
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1067
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1068
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1069
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1070
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1071
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1072
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1073
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1074
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1075
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1076
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1077
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1078
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1079
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1080
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1081
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1082
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1083
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1084
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1085
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1086
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1087
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1088
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1089
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1090
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1091
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1092
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1093
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1094
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1095
|
+
fully populated account.`),
|
|
1096
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1097
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1098
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1099
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1100
|
+
});
|
|
1101
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1102
|
+
serverUrl: z.string().optional(),
|
|
1103
|
+
name: z.string().optional(),
|
|
1104
|
+
slug: z.string().optional(),
|
|
1105
|
+
oneLiner: z.string().optional(),
|
|
1106
|
+
description: z.string().optional(),
|
|
1107
|
+
iconUrl: z.string().optional(),
|
|
1108
|
+
documentation: z.string().optional(),
|
|
1109
|
+
support: z.string().optional(),
|
|
1110
|
+
privacyPolicy: z.string().optional(),
|
|
1111
|
+
companyWebsite: z.string().optional(),
|
|
1112
|
+
primaryContactEmail: z.string().optional(),
|
|
1113
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1114
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1133
1115
|
});
|
|
1134
1116
|
claudeSubmissionFormDataSchema.pick({
|
|
1135
|
-
companyName: true,
|
|
1136
|
-
appName: true,
|
|
1137
|
-
mcpUrlType: true,
|
|
1138
1117
|
serverUrl: true,
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
transportSupport: true,
|
|
1118
|
+
name: true,
|
|
1119
|
+
slug: true,
|
|
1120
|
+
companyName: true,
|
|
1143
1121
|
primaryContactEmail: true,
|
|
1144
1122
|
primaryContactName: true,
|
|
1123
|
+
readWriteCapabilities: true,
|
|
1145
1124
|
authentication: true,
|
|
1146
|
-
|
|
1147
|
-
|
|
1125
|
+
apiOwnership: true,
|
|
1126
|
+
personalHealthData: true
|
|
1148
1127
|
}).extend({
|
|
1149
1128
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1150
|
-
|
|
1129
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1130
|
+
});
|
|
1131
|
+
/**
|
|
1132
|
+
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1133
|
+
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1134
|
+
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1135
|
+
* colocated with the Claude contract.
|
|
1136
|
+
*/
|
|
1137
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1138
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1139
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1140
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1141
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1142
|
+
});
|
|
1143
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1144
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1145
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1151
1146
|
});
|
|
1152
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1153
|
-
tagline: true,
|
|
1154
|
-
description: true,
|
|
1155
|
-
category: true,
|
|
1156
|
-
testCases: true
|
|
1157
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
1158
1147
|
const submissionMetaFieldsSchema = z.object({
|
|
1159
1148
|
id: z.string(),
|
|
1160
1149
|
environmentId: z.string(),
|
|
1150
|
+
auditId: z.string().nullable(),
|
|
1161
1151
|
createdAt: z.coerce.date(),
|
|
1162
1152
|
updatedAt: z.coerce.date()
|
|
1163
1153
|
});
|
|
1164
1154
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1165
1155
|
platform: z.literal("claudeai"),
|
|
1166
|
-
formData:
|
|
1156
|
+
formData: claudeSubmissionDraftSchema
|
|
1167
1157
|
});
|
|
1168
1158
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1169
1159
|
platform: z.literal("chatgpt"),
|
|
1170
|
-
formData:
|
|
1160
|
+
formData: chatgptSubmissionDraftSchema
|
|
1171
1161
|
});
|
|
1172
1162
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1173
|
-
z.union([
|
|
1163
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1174
1164
|
const subscriptionPlanSchema = z.enum([
|
|
1175
1165
|
"pro",
|
|
1176
1166
|
"business",
|
|
@@ -1194,6 +1184,12 @@ z.object({
|
|
|
1194
1184
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1195
1185
|
});
|
|
1196
1186
|
//#endregion
|
|
1187
|
+
//#region src/auth-scope.ts
|
|
1188
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1189
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1190
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1191
|
+
const AUTH_SCOPE_USER = "user";
|
|
1192
|
+
//#endregion
|
|
1197
1193
|
//#region src/schemas.ts
|
|
1198
1194
|
const RESERVED_KEYS = [
|
|
1199
1195
|
"_HANDLER",
|
|
@@ -1422,7 +1418,8 @@ const createProjectContractV1 = oc.route({
|
|
|
1422
1418
|
successDescription: "The project has been created successfully"
|
|
1423
1419
|
}).errors({
|
|
1424
1420
|
NOT_FOUND: {},
|
|
1425
|
-
BAD_REQUEST: {}
|
|
1421
|
+
BAD_REQUEST: {},
|
|
1422
|
+
FORBIDDEN: {}
|
|
1426
1423
|
}).input(z.object({
|
|
1427
1424
|
teamId: z.string().optional(),
|
|
1428
1425
|
name: z.string().trim().min(1).max(100),
|
|
@@ -1528,7 +1525,8 @@ const updateProjectContractV1 = oc.route({
|
|
|
1528
1525
|
successDescription: "The project has been updated successfully"
|
|
1529
1526
|
}).errors({
|
|
1530
1527
|
NOT_FOUND: {},
|
|
1531
|
-
BAD_REQUEST: {}
|
|
1528
|
+
BAD_REQUEST: {},
|
|
1529
|
+
FORBIDDEN: {}
|
|
1532
1530
|
}).input(z.object({
|
|
1533
1531
|
projectId: z.string().describe("The ID of the project"),
|
|
1534
1532
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
@@ -1546,7 +1544,8 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1546
1544
|
BAD_REQUEST: {}
|
|
1547
1545
|
}).input(z.object({
|
|
1548
1546
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1549
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1547
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1548
|
+
settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
|
|
1550
1549
|
})).output(deploymentSchema);
|
|
1551
1550
|
const uploadDeploymentArtifactContractV1 = oc.route({
|
|
1552
1551
|
path: "/v1/deployments/upload",
|
|
@@ -1731,7 +1730,7 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1731
1730
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1732
1731
|
tags: ["tunnels"],
|
|
1733
1732
|
successDescription: "The tunnel ticket"
|
|
1734
|
-
}).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1733
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1735
1734
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1736
1735
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1737
1736
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
@@ -1885,4 +1884,4 @@ const contract = {
|
|
|
1885
1884
|
}
|
|
1886
1885
|
};
|
|
1887
1886
|
//#endregion
|
|
1888
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
1887
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@alpic-ai/api",
|
|
3
|
-
"version": "0.0.0-dev.
|
|
3
|
+
"version": "0.0.0-dev.gf1cbef7",
|
|
4
4
|
"description": "Contract for the Alpic API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.mjs",
|
|
@@ -14,22 +14,38 @@
|
|
|
14
14
|
"files": [
|
|
15
15
|
"dist"
|
|
16
16
|
],
|
|
17
|
+
"nx": {
|
|
18
|
+
"targets": {
|
|
19
|
+
"build": {
|
|
20
|
+
"cache": true,
|
|
21
|
+
"inputs": [
|
|
22
|
+
"{projectRoot}/src/**/*",
|
|
23
|
+
"{projectRoot}/tsdown.config.ts",
|
|
24
|
+
"{projectRoot}/tsconfig.json",
|
|
25
|
+
"^default"
|
|
26
|
+
],
|
|
27
|
+
"outputs": [
|
|
28
|
+
"{projectRoot}/dist"
|
|
29
|
+
]
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
},
|
|
17
33
|
"author": "Alpic",
|
|
18
34
|
"license": "ISC",
|
|
19
35
|
"dependencies": {
|
|
20
|
-
"@orpc/contract": "^1.14.
|
|
36
|
+
"@orpc/contract": "^1.14.7",
|
|
21
37
|
"ms": "^2.1.3",
|
|
22
38
|
"zod": "^4.4.3"
|
|
23
39
|
},
|
|
24
40
|
"devDependencies": {
|
|
25
|
-
"@orpc/openapi": "^1.14.
|
|
26
|
-
"@orpc/zod": "^1.14.
|
|
41
|
+
"@orpc/openapi": "^1.14.7",
|
|
42
|
+
"@orpc/zod": "^1.14.7",
|
|
27
43
|
"@total-typescript/tsconfig": "^1.0.4",
|
|
28
44
|
"@types/ms": "^2.1.0",
|
|
29
45
|
"shx": "^0.4.0",
|
|
30
|
-
"tsdown": "^0.22.
|
|
46
|
+
"tsdown": "^0.22.5",
|
|
31
47
|
"typescript": "^6.0.3",
|
|
32
|
-
"vitest": "^4.1.
|
|
48
|
+
"vitest": "^4.1.10",
|
|
33
49
|
"@alpic-ai/domains": "0.0.0"
|
|
34
50
|
},
|
|
35
51
|
"scripts": {
|
|
@@ -38,7 +54,7 @@
|
|
|
38
54
|
"test": "pnpm run test:unit && pnpm run test:type && pnpm run test:format",
|
|
39
55
|
"test:unit": "vitest run",
|
|
40
56
|
"test:format": "biome check --error-on-warnings .",
|
|
41
|
-
"test:type": "
|
|
57
|
+
"test:type": "tsgo --noEmit",
|
|
42
58
|
"publish:npm": "pnpm publish --tag \"${NPM_TAG}\" --access public --no-git-checks"
|
|
43
59
|
}
|
|
44
60
|
}
|