@alpic-ai/api 0.0.0-staging.fc83d5f → 0.0.0-staging.fd696be
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 +273 -46
- package/dist/index.mjs +529 -6
- package/package.json +18 -6
package/dist/index.d.mts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import * as _orpc_contract0 from "@orpc/contract";
|
|
2
|
-
import { InferContractRouterInputs, InferContractRouterOutputs } from "@orpc/contract";
|
|
3
1
|
import { z } from "zod";
|
|
2
|
+
import * as _$_orpc_contract0 from "@orpc/contract";
|
|
3
|
+
import { InferContractRouterInputs, InferContractRouterOutputs } from "@orpc/contract";
|
|
4
4
|
|
|
5
5
|
//#region src/api.contract.d.ts
|
|
6
6
|
type ApiContext = {
|
|
@@ -16,7 +16,7 @@ declare const deploymentStatusSchema: z.ZodEnum<{
|
|
|
16
16
|
failed: "failed";
|
|
17
17
|
canceled: "canceled";
|
|
18
18
|
}>;
|
|
19
|
-
declare const createEnvironmentContractV1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
19
|
+
declare const createEnvironmentContractV1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
20
20
|
projectId: z.ZodString;
|
|
21
21
|
name: z.ZodString;
|
|
22
22
|
sourceBranch: z.ZodString;
|
|
@@ -32,14 +32,14 @@ declare const createEnvironmentContractV1: _orpc_contract0.ContractProcedureBuil
|
|
|
32
32
|
urls: z.ZodArray<z.ZodString>;
|
|
33
33
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
34
34
|
projectId: z.ZodString;
|
|
35
|
-
}, z.core.$strip>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
35
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
36
36
|
NOT_FOUND: {};
|
|
37
37
|
BAD_REQUEST: {};
|
|
38
38
|
}>, Record<never, never>>;
|
|
39
39
|
declare const contract: {
|
|
40
40
|
teams: {
|
|
41
41
|
list: {
|
|
42
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithOutput<_orpc_contract0.Schema<unknown, unknown>, z.ZodArray<z.ZodObject<{
|
|
42
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithOutput<_$_orpc_contract0.Schema<unknown, unknown>, z.ZodArray<z.ZodObject<{
|
|
43
43
|
id: z.ZodString;
|
|
44
44
|
name: z.ZodString;
|
|
45
45
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
@@ -49,7 +49,7 @@ declare const contract: {
|
|
|
49
49
|
};
|
|
50
50
|
analytics: {
|
|
51
51
|
get: {
|
|
52
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
52
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
53
53
|
projectId: z.ZodString;
|
|
54
54
|
startTimestamp: z.ZodCoercedNumber<unknown>;
|
|
55
55
|
endTimestamp: z.ZodCoercedNumber<unknown>;
|
|
@@ -92,7 +92,7 @@ declare const contract: {
|
|
|
92
92
|
categories: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
93
93
|
}, z.core.$strip>>;
|
|
94
94
|
}, z.core.$strip>;
|
|
95
|
-
}, z.core.$strip>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
95
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
96
96
|
NOT_FOUND: {};
|
|
97
97
|
BAD_REQUEST: {};
|
|
98
98
|
}>, Record<never, never>>;
|
|
@@ -100,7 +100,7 @@ declare const contract: {
|
|
|
100
100
|
};
|
|
101
101
|
deployments: {
|
|
102
102
|
list: {
|
|
103
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
103
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
104
104
|
projectId: z.ZodString;
|
|
105
105
|
status: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
106
106
|
ongoing: "ongoing";
|
|
@@ -128,12 +128,12 @@ declare const contract: {
|
|
|
128
128
|
environmentName: z.ZodString;
|
|
129
129
|
isCurrent: z.ZodBoolean;
|
|
130
130
|
deploymentPageUrl: z.ZodNullable<z.ZodURL>;
|
|
131
|
-
}, z.core.$strip>>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
131
|
+
}, z.core.$strip>>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
132
132
|
NOT_FOUND: {};
|
|
133
133
|
}>, Record<never, never>>;
|
|
134
134
|
};
|
|
135
135
|
get: {
|
|
136
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
136
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
137
137
|
deploymentId: z.ZodString;
|
|
138
138
|
}, z.core.$strip>, z.ZodObject<{
|
|
139
139
|
id: z.ZodString;
|
|
@@ -154,12 +154,12 @@ declare const contract: {
|
|
|
154
154
|
environmentName: z.ZodString;
|
|
155
155
|
isCurrent: z.ZodBoolean;
|
|
156
156
|
deploymentPageUrl: z.ZodNullable<z.ZodURL>;
|
|
157
|
-
}, z.core.$strip>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
157
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
158
158
|
NOT_FOUND: {};
|
|
159
159
|
}>, Record<never, never>>;
|
|
160
160
|
};
|
|
161
161
|
uploadArtifact: {
|
|
162
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodOptional<z.ZodObject<{
|
|
162
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodOptional<z.ZodObject<{
|
|
163
163
|
teamId: z.ZodOptional<z.ZodString>;
|
|
164
164
|
}, z.core.$strip>>, z.ZodObject<{
|
|
165
165
|
uploadUrl: z.ZodURL;
|
|
@@ -168,7 +168,7 @@ declare const contract: {
|
|
|
168
168
|
}, z.core.$strip>, Record<never, never>, Record<never, never>>;
|
|
169
169
|
};
|
|
170
170
|
getLogs: {
|
|
171
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
171
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
172
172
|
deploymentId: z.ZodString;
|
|
173
173
|
}, z.core.$strip>, z.ZodObject<{
|
|
174
174
|
logs: z.ZodArray<z.ZodObject<{
|
|
@@ -176,14 +176,14 @@ declare const contract: {
|
|
|
176
176
|
content: z.ZodOptional<z.ZodString>;
|
|
177
177
|
}, z.core.$strip>>;
|
|
178
178
|
hasMoreLogs: z.ZodBoolean;
|
|
179
|
-
}, z.core.$strip>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
179
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
180
180
|
NOT_FOUND: {};
|
|
181
181
|
}>, Record<never, never>>;
|
|
182
182
|
};
|
|
183
183
|
};
|
|
184
184
|
environments: {
|
|
185
185
|
create: {
|
|
186
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
186
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
187
187
|
projectId: z.ZodString;
|
|
188
188
|
name: z.ZodString;
|
|
189
189
|
sourceBranch: z.ZodString;
|
|
@@ -199,13 +199,13 @@ declare const contract: {
|
|
|
199
199
|
urls: z.ZodArray<z.ZodString>;
|
|
200
200
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
201
201
|
projectId: z.ZodString;
|
|
202
|
-
}, z.core.$strip>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
202
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
203
203
|
NOT_FOUND: {};
|
|
204
204
|
BAD_REQUEST: {};
|
|
205
205
|
}>, Record<never, never>>;
|
|
206
206
|
};
|
|
207
207
|
get: {
|
|
208
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
208
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
209
209
|
environmentId: z.ZodString;
|
|
210
210
|
}, z.core.$strip>, z.ZodObject<{
|
|
211
211
|
id: z.ZodString;
|
|
@@ -215,12 +215,12 @@ declare const contract: {
|
|
|
215
215
|
domains: z.ZodArray<z.ZodURL>;
|
|
216
216
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
217
217
|
projectId: z.ZodString;
|
|
218
|
-
}, z.core.$strip>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
218
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
219
219
|
NOT_FOUND: {};
|
|
220
220
|
}>, Record<never, never>>;
|
|
221
221
|
};
|
|
222
222
|
deploy: {
|
|
223
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
223
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
224
224
|
environmentId: z.ZodString;
|
|
225
225
|
token: z.ZodOptional<z.ZodString>;
|
|
226
226
|
}, z.core.$strip>, z.ZodObject<{
|
|
@@ -242,13 +242,13 @@ declare const contract: {
|
|
|
242
242
|
environmentName: z.ZodString;
|
|
243
243
|
isCurrent: z.ZodBoolean;
|
|
244
244
|
deploymentPageUrl: z.ZodNullable<z.ZodURL>;
|
|
245
|
-
}, z.core.$strip>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
245
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
246
246
|
NOT_FOUND: {};
|
|
247
247
|
BAD_REQUEST: {};
|
|
248
248
|
}>, Record<never, never>>;
|
|
249
249
|
};
|
|
250
250
|
getLogs: {
|
|
251
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
251
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
252
252
|
environmentId: z.ZodString;
|
|
253
253
|
since: z.ZodOptional<z.ZodString>;
|
|
254
254
|
until: z.ZodOptional<z.ZodString>;
|
|
@@ -278,7 +278,39 @@ declare const contract: {
|
|
|
278
278
|
durationInMs: z.ZodOptional<z.ZodNumber>;
|
|
279
279
|
}, z.core.$strip>>;
|
|
280
280
|
nextToken: z.ZodNullable<z.ZodString>;
|
|
281
|
-
}, z.core.$strip>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
281
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
282
|
+
NOT_FOUND: {};
|
|
283
|
+
BAD_REQUEST: {};
|
|
284
|
+
}>, Record<never, never>>;
|
|
285
|
+
};
|
|
286
|
+
getLatestLogs: {
|
|
287
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
288
|
+
environmentId: z.ZodString;
|
|
289
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
290
|
+
level: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
291
|
+
INFO: "INFO";
|
|
292
|
+
ERROR: "ERROR";
|
|
293
|
+
WARNING: "WARNING";
|
|
294
|
+
DEBUG: "DEBUG";
|
|
295
|
+
}>>>;
|
|
296
|
+
search: z.ZodOptional<z.ZodString>;
|
|
297
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
298
|
+
logs: z.ZodArray<z.ZodObject<{
|
|
299
|
+
timestamp: z.ZodCoercedDate<unknown>;
|
|
300
|
+
type: z.ZodEnum<{
|
|
301
|
+
INFO: "INFO";
|
|
302
|
+
ERROR: "ERROR";
|
|
303
|
+
WARNING: "WARNING";
|
|
304
|
+
DEBUG: "DEBUG";
|
|
305
|
+
START: "START";
|
|
306
|
+
END: "END";
|
|
307
|
+
}>;
|
|
308
|
+
requestId: z.ZodString;
|
|
309
|
+
content: z.ZodOptional<z.ZodString>;
|
|
310
|
+
method: z.ZodOptional<z.ZodString>;
|
|
311
|
+
durationInMs: z.ZodOptional<z.ZodNumber>;
|
|
312
|
+
}, z.core.$strip>>;
|
|
313
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
282
314
|
NOT_FOUND: {};
|
|
283
315
|
BAD_REQUEST: {};
|
|
284
316
|
}>, Record<never, never>>;
|
|
@@ -286,7 +318,7 @@ declare const contract: {
|
|
|
286
318
|
};
|
|
287
319
|
environmentVariables: {
|
|
288
320
|
list: {
|
|
289
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
321
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
290
322
|
environmentId: z.ZodString;
|
|
291
323
|
}, z.core.$strip>, z.ZodArray<z.ZodObject<{
|
|
292
324
|
id: z.ZodString;
|
|
@@ -294,12 +326,12 @@ declare const contract: {
|
|
|
294
326
|
value: z.ZodString;
|
|
295
327
|
isSecret: z.ZodBoolean;
|
|
296
328
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
297
|
-
}, z.core.$strip>>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
329
|
+
}, z.core.$strip>>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
298
330
|
NOT_FOUND: {};
|
|
299
331
|
}>, Record<never, never>>;
|
|
300
332
|
};
|
|
301
333
|
create: {
|
|
302
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
334
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
303
335
|
environmentId: z.ZodString;
|
|
304
336
|
environmentVariables: z.ZodArray<z.ZodObject<{
|
|
305
337
|
key: z.ZodString;
|
|
@@ -308,37 +340,37 @@ declare const contract: {
|
|
|
308
340
|
}, z.core.$strip>>;
|
|
309
341
|
}, z.core.$strip>, z.ZodObject<{
|
|
310
342
|
success: z.ZodLiteral<true>;
|
|
311
|
-
}, z.core.$strip>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
343
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
312
344
|
NOT_FOUND: {};
|
|
313
345
|
BAD_REQUEST: {};
|
|
314
346
|
}>, Record<never, never>>;
|
|
315
347
|
};
|
|
316
348
|
update: {
|
|
317
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
349
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
318
350
|
environmentVariableId: z.ZodString;
|
|
319
351
|
key: z.ZodString;
|
|
320
352
|
value: z.ZodOptional<z.ZodString>;
|
|
321
|
-
isSecret: z.ZodDefault<z.ZodBoolean
|
|
353
|
+
isSecret: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
322
354
|
}, z.core.$strip>, z.ZodObject<{
|
|
323
355
|
success: z.ZodLiteral<true>;
|
|
324
|
-
}, z.core.$strip>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
356
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
325
357
|
NOT_FOUND: {};
|
|
326
358
|
BAD_REQUEST: {};
|
|
327
359
|
}>, Record<never, never>>;
|
|
328
360
|
};
|
|
329
361
|
delete: {
|
|
330
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
362
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
331
363
|
environmentVariableId: z.ZodString;
|
|
332
364
|
}, z.core.$strip>, z.ZodObject<{
|
|
333
365
|
success: z.ZodLiteral<true>;
|
|
334
|
-
}, z.core.$strip>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
366
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
335
367
|
NOT_FOUND: {};
|
|
336
368
|
}>, Record<never, never>>;
|
|
337
369
|
};
|
|
338
370
|
};
|
|
339
371
|
projects: {
|
|
340
372
|
update: {
|
|
341
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
373
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
342
374
|
projectId: z.ZodString;
|
|
343
375
|
name: z.ZodOptional<z.ZodString>;
|
|
344
376
|
sourceRepository: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
@@ -410,13 +442,13 @@ declare const contract: {
|
|
|
410
442
|
completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
|
|
411
443
|
}, z.core.$strip>>;
|
|
412
444
|
}, z.core.$strip>>;
|
|
413
|
-
}, z.core.$strip>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
445
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
414
446
|
NOT_FOUND: {};
|
|
415
447
|
BAD_REQUEST: {};
|
|
416
448
|
}>, Record<never, never>>;
|
|
417
449
|
};
|
|
418
450
|
get: {
|
|
419
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
451
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
420
452
|
projectId: z.ZodString;
|
|
421
453
|
}, z.core.$strip>, z.ZodObject<{
|
|
422
454
|
id: z.ZodString;
|
|
@@ -486,12 +518,12 @@ declare const contract: {
|
|
|
486
518
|
completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
|
|
487
519
|
}, z.core.$strip>>;
|
|
488
520
|
}, z.core.$strip>>;
|
|
489
|
-
}, z.core.$strip>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
521
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
490
522
|
NOT_FOUND: {};
|
|
491
523
|
}>, Record<never, never>>;
|
|
492
524
|
};
|
|
493
525
|
list: {
|
|
494
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodOptional<z.ZodObject<{
|
|
526
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodOptional<z.ZodObject<{
|
|
495
527
|
teamId: z.ZodOptional<z.ZodString>;
|
|
496
528
|
}, z.core.$strip>>, z.ZodArray<z.ZodObject<{
|
|
497
529
|
id: z.ZodString;
|
|
@@ -564,7 +596,7 @@ declare const contract: {
|
|
|
564
596
|
}, z.core.$strip>>, Record<never, never>, Record<never, never>>;
|
|
565
597
|
};
|
|
566
598
|
create: {
|
|
567
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
599
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
568
600
|
teamId: z.ZodOptional<z.ZodString>;
|
|
569
601
|
name: z.ZodString;
|
|
570
602
|
sourceRepository: z.ZodOptional<z.ZodString>;
|
|
@@ -622,24 +654,86 @@ declare const contract: {
|
|
|
622
654
|
installCommand: z.ZodNullable<z.ZodString>;
|
|
623
655
|
startCommand: z.ZodNullable<z.ZodString>;
|
|
624
656
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
625
|
-
}, z.core.$strip>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
657
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
626
658
|
NOT_FOUND: {};
|
|
627
659
|
BAD_REQUEST: {};
|
|
628
660
|
}>, Record<never, never>>;
|
|
629
661
|
};
|
|
630
662
|
delete: {
|
|
631
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
663
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
632
664
|
projectId: z.ZodString;
|
|
633
665
|
}, z.core.$strip>, z.ZodObject<{
|
|
634
666
|
success: z.ZodLiteral<true>;
|
|
635
|
-
}, z.core.$strip>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
667
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
636
668
|
NOT_FOUND: {};
|
|
637
669
|
}>, Record<never, never>>;
|
|
638
670
|
};
|
|
639
671
|
};
|
|
672
|
+
playground: {
|
|
673
|
+
get: {
|
|
674
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
675
|
+
environmentId: z.ZodString;
|
|
676
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
677
|
+
isPlaygroundEnabled: z.ZodBoolean;
|
|
678
|
+
serverMetadata: z.ZodNullable<z.ZodObject<{
|
|
679
|
+
name: z.ZodString;
|
|
680
|
+
description: z.ZodString;
|
|
681
|
+
headers: z.ZodArray<z.ZodObject<{
|
|
682
|
+
name: z.ZodString;
|
|
683
|
+
description: z.ZodString;
|
|
684
|
+
isRequired: z.ZodBoolean;
|
|
685
|
+
isSecret: z.ZodBoolean;
|
|
686
|
+
}, z.core.$strip>>;
|
|
687
|
+
examplePrompts: z.ZodArray<z.ZodObject<{
|
|
688
|
+
title: z.ZodString;
|
|
689
|
+
prompt: z.ZodString;
|
|
690
|
+
}, z.core.$strip>>;
|
|
691
|
+
}, z.core.$strip>>;
|
|
692
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
693
|
+
NOT_FOUND: {};
|
|
694
|
+
}>, Record<never, never>>;
|
|
695
|
+
};
|
|
696
|
+
upsert: {
|
|
697
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
698
|
+
environmentId: z.ZodString;
|
|
699
|
+
isPlaygroundEnabled: z.ZodOptional<z.ZodBoolean>;
|
|
700
|
+
name: z.ZodOptional<z.ZodString>;
|
|
701
|
+
description: z.ZodOptional<z.ZodString>;
|
|
702
|
+
headers: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
703
|
+
name: z.ZodString;
|
|
704
|
+
description: z.ZodString;
|
|
705
|
+
isRequired: z.ZodDefault<z.ZodBoolean>;
|
|
706
|
+
isSecret: z.ZodDefault<z.ZodBoolean>;
|
|
707
|
+
}, z.core.$strip>>>;
|
|
708
|
+
examplePrompts: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
709
|
+
title: z.ZodString;
|
|
710
|
+
prompt: z.ZodString;
|
|
711
|
+
}, z.core.$strip>>>;
|
|
712
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
713
|
+
isPlaygroundEnabled: z.ZodBoolean;
|
|
714
|
+
serverMetadata: z.ZodNullable<z.ZodObject<{
|
|
715
|
+
name: z.ZodString;
|
|
716
|
+
description: z.ZodString;
|
|
717
|
+
headers: z.ZodArray<z.ZodObject<{
|
|
718
|
+
name: z.ZodString;
|
|
719
|
+
description: z.ZodString;
|
|
720
|
+
isRequired: z.ZodBoolean;
|
|
721
|
+
isSecret: z.ZodBoolean;
|
|
722
|
+
}, z.core.$strip>>;
|
|
723
|
+
examplePrompts: z.ZodArray<z.ZodObject<{
|
|
724
|
+
title: z.ZodString;
|
|
725
|
+
prompt: z.ZodString;
|
|
726
|
+
}, z.core.$strip>>;
|
|
727
|
+
}, z.core.$strip>>;
|
|
728
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
729
|
+
NOT_FOUND: {};
|
|
730
|
+
BAD_REQUEST: {};
|
|
731
|
+
}>, Record<never, never>>;
|
|
732
|
+
};
|
|
733
|
+
};
|
|
640
734
|
tunnels: {
|
|
641
735
|
getTicket: {
|
|
642
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithOutput<_orpc_contract0.Schema<unknown, unknown>, z.ZodObject<{
|
|
736
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithOutput<_$_orpc_contract0.Schema<unknown, unknown>, z.ZodObject<{
|
|
643
737
|
subdomain: z.ZodString;
|
|
644
738
|
ticket: z.ZodString;
|
|
645
739
|
tunnelHost: z.ZodString;
|
|
@@ -648,7 +742,7 @@ declare const contract: {
|
|
|
648
742
|
};
|
|
649
743
|
distribution: {
|
|
650
744
|
publish: {
|
|
651
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
745
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
652
746
|
projectId: z.ZodString;
|
|
653
747
|
domain: z.ZodString;
|
|
654
748
|
title: z.ZodString;
|
|
@@ -680,13 +774,13 @@ declare const contract: {
|
|
|
680
774
|
}, z.core.$strip>>>;
|
|
681
775
|
}, z.core.$strip>>>;
|
|
682
776
|
}, z.core.$strip>;
|
|
683
|
-
}, z.core.$strip>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
777
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
684
778
|
NOT_FOUND: {};
|
|
685
779
|
BAD_REQUEST: {};
|
|
686
780
|
}>, Record<never, never>>;
|
|
687
781
|
};
|
|
688
782
|
get: {
|
|
689
|
-
v1: _orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
783
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
690
784
|
projectId: z.ZodString;
|
|
691
785
|
domain: z.ZodString;
|
|
692
786
|
}, z.core.$strip>, z.ZodObject<{
|
|
@@ -713,16 +807,134 @@ declare const contract: {
|
|
|
713
807
|
}, z.core.$strip>>>;
|
|
714
808
|
}, z.core.$strip>>>;
|
|
715
809
|
}, z.core.$strip>;
|
|
716
|
-
}, z.core.$strip>, _orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
810
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
811
|
+
NOT_FOUND: {};
|
|
812
|
+
BAD_REQUEST: {};
|
|
813
|
+
}>, Record<never, never>>;
|
|
814
|
+
};
|
|
815
|
+
};
|
|
816
|
+
beacon: {
|
|
817
|
+
create: {
|
|
818
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
819
|
+
targetUrl: z.ZodURL;
|
|
820
|
+
teamId: z.ZodOptional<z.ZodString>;
|
|
821
|
+
projectId: z.ZodOptional<z.ZodString>;
|
|
822
|
+
excludeCategories: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
823
|
+
connectivity: "connectivity";
|
|
824
|
+
"tool-metadata": "tool-metadata";
|
|
825
|
+
"resource-metadata": "resource-metadata";
|
|
826
|
+
performance: "performance";
|
|
827
|
+
e2e: "e2e";
|
|
828
|
+
}>>>;
|
|
829
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
830
|
+
id: z.ZodString;
|
|
831
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
717
832
|
NOT_FOUND: {};
|
|
718
833
|
BAD_REQUEST: {};
|
|
719
834
|
}>, Record<never, never>>;
|
|
720
835
|
};
|
|
836
|
+
get: {
|
|
837
|
+
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
838
|
+
auditId: z.ZodString;
|
|
839
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
840
|
+
id: z.ZodString;
|
|
841
|
+
targetUrl: z.ZodString;
|
|
842
|
+
status: z.ZodEnum<{
|
|
843
|
+
failed: "failed";
|
|
844
|
+
pending: "pending";
|
|
845
|
+
partial: "partial";
|
|
846
|
+
completed: "completed";
|
|
847
|
+
}>;
|
|
848
|
+
durationMs: z.ZodNullable<z.ZodNumber>;
|
|
849
|
+
createdAt: z.ZodCoercedDate<unknown>;
|
|
850
|
+
report: z.ZodNullable<z.ZodObject<{
|
|
851
|
+
schemaVersion: z.ZodString;
|
|
852
|
+
auditId: z.ZodString;
|
|
853
|
+
targetUrl: z.ZodString;
|
|
854
|
+
startedAt: z.ZodString;
|
|
855
|
+
completedAt: z.ZodString;
|
|
856
|
+
durationMs: z.ZodNumber;
|
|
857
|
+
results: z.ZodArray<z.ZodObject<{
|
|
858
|
+
checkId: z.ZodString;
|
|
859
|
+
checkName: z.ZodString;
|
|
860
|
+
description: z.ZodString;
|
|
861
|
+
status: z.ZodEnum<{
|
|
862
|
+
pending: "pending";
|
|
863
|
+
pass: "pass";
|
|
864
|
+
fail: "fail";
|
|
865
|
+
skip: "skip";
|
|
866
|
+
}>;
|
|
867
|
+
message: z.ZodString;
|
|
868
|
+
skipReason: z.ZodOptional<z.ZodString>;
|
|
869
|
+
severity: z.ZodEnum<{
|
|
870
|
+
error: "error";
|
|
871
|
+
warning: "warning";
|
|
872
|
+
info: "info";
|
|
873
|
+
}>;
|
|
874
|
+
category: z.ZodEnum<{
|
|
875
|
+
connectivity: "connectivity";
|
|
876
|
+
"tool-metadata": "tool-metadata";
|
|
877
|
+
"resource-metadata": "resource-metadata";
|
|
878
|
+
performance: "performance";
|
|
879
|
+
e2e: "e2e";
|
|
880
|
+
}>;
|
|
881
|
+
scope: z.ZodEnum<{
|
|
882
|
+
server: "server";
|
|
883
|
+
view: "view";
|
|
884
|
+
}>;
|
|
885
|
+
platforms: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
|
|
886
|
+
chatgpt: "chatgpt";
|
|
887
|
+
claudeai: "claudeai";
|
|
888
|
+
}>>>>;
|
|
889
|
+
durationMs: z.ZodNumber;
|
|
890
|
+
details: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
891
|
+
label: z.ZodString;
|
|
892
|
+
value: z.ZodOptional<z.ZodString>;
|
|
893
|
+
}, z.core.$strip>>>;
|
|
894
|
+
hint: z.ZodOptional<z.ZodObject<{
|
|
895
|
+
text: z.ZodString;
|
|
896
|
+
}, z.core.$strip>>;
|
|
897
|
+
}, z.core.$strip>>;
|
|
898
|
+
requiresAuth: z.ZodBoolean;
|
|
899
|
+
hasViewSupport: z.ZodBoolean;
|
|
900
|
+
viewPlatforms: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
|
|
901
|
+
chatgpt: "chatgpt";
|
|
902
|
+
claudeai: "claudeai";
|
|
903
|
+
}>>>>;
|
|
904
|
+
isReadyForPlatform: z.ZodRecord<z.ZodEnum<{
|
|
905
|
+
chatgpt: "chatgpt";
|
|
906
|
+
claudeai: "claudeai";
|
|
907
|
+
}>, z.ZodBoolean>;
|
|
908
|
+
widgetScreenshotKeys: z.ZodObject<{
|
|
909
|
+
chatgpt: z.ZodOptional<z.ZodString>;
|
|
910
|
+
claudeai: z.ZodOptional<z.ZodString>;
|
|
911
|
+
}, z.core.$strip>;
|
|
912
|
+
widgetScreenshots: z.ZodObject<{
|
|
913
|
+
chatgpt: z.ZodOptional<z.ZodObject<{
|
|
914
|
+
url: z.ZodString;
|
|
915
|
+
}, z.core.$strip>>;
|
|
916
|
+
claudeai: z.ZodOptional<z.ZodObject<{
|
|
917
|
+
url: z.ZodString;
|
|
918
|
+
}, z.core.$strip>>;
|
|
919
|
+
}, z.core.$strip>;
|
|
920
|
+
}, z.core.$strip>>;
|
|
921
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
922
|
+
NOT_FOUND: {};
|
|
923
|
+
}>, Record<never, never>>;
|
|
924
|
+
};
|
|
721
925
|
};
|
|
722
926
|
};
|
|
723
927
|
type RouterInput = InferContractRouterInputs<typeof contract>;
|
|
724
928
|
type RouterOutput = InferContractRouterOutputs<typeof contract>;
|
|
725
929
|
//#endregion
|
|
930
|
+
//#region ../domains/src/platforms/schemas.d.ts
|
|
931
|
+
declare const platformSchema: z.ZodEnum<{
|
|
932
|
+
chatgpt: "chatgpt";
|
|
933
|
+
claudeai: "claudeai";
|
|
934
|
+
}>;
|
|
935
|
+
type Platform = z.infer<typeof platformSchema>;
|
|
936
|
+
declare const PLATFORM_LABELS: Record<Platform, string>;
|
|
937
|
+
//#endregion
|
|
726
938
|
//#region src/schemas.d.ts
|
|
727
939
|
declare const environmentVariableSchema: z.ZodObject<{
|
|
728
940
|
key: z.ZodString;
|
|
@@ -734,6 +946,11 @@ declare const environmentVariablesSchema: z.ZodArray<z.ZodObject<{
|
|
|
734
946
|
value: z.ZodString;
|
|
735
947
|
isSecret: z.ZodDefault<z.ZodBoolean>;
|
|
736
948
|
}, z.core.$strip>>;
|
|
949
|
+
declare const updateEnvironmentVariableSchema: z.ZodObject<{
|
|
950
|
+
key: z.ZodString;
|
|
951
|
+
value: z.ZodOptional<z.ZodString>;
|
|
952
|
+
isSecret: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
953
|
+
}, z.core.$strip>;
|
|
737
954
|
declare const buildSettingsSchema: z.ZodObject<{
|
|
738
955
|
installCommand: z.ZodOptional<z.ZodString>;
|
|
739
956
|
buildCommand: z.ZodOptional<z.ZodString>;
|
|
@@ -753,6 +970,16 @@ declare const transportSchema: z.ZodEnum<{
|
|
|
753
970
|
streamablehttp: "streamablehttp";
|
|
754
971
|
}>;
|
|
755
972
|
type Transport = z.infer<typeof transportSchema>;
|
|
973
|
+
declare const playgroundHeaderSchema: z.ZodObject<{
|
|
974
|
+
name: z.ZodString;
|
|
975
|
+
description: z.ZodString;
|
|
976
|
+
isRequired: z.ZodDefault<z.ZodBoolean>;
|
|
977
|
+
isSecret: z.ZodDefault<z.ZodBoolean>;
|
|
978
|
+
}, z.core.$strip>;
|
|
979
|
+
declare const playgroundExamplePromptSchema: z.ZodObject<{
|
|
980
|
+
title: z.ZodString;
|
|
981
|
+
prompt: z.ZodString;
|
|
982
|
+
}, z.core.$strip>;
|
|
756
983
|
declare const serverFieldsSchema: z.ZodObject<{
|
|
757
984
|
$schema: z.ZodString;
|
|
758
985
|
name: z.ZodString;
|
|
@@ -777,4 +1004,4 @@ declare const serverFieldsSchema: z.ZodObject<{
|
|
|
777
1004
|
}, z.core.$strip>>>;
|
|
778
1005
|
}, z.core.$strip>;
|
|
779
1006
|
//#endregion
|
|
780
|
-
export { ApiContext, RouterInput, RouterOutput, Runtime, Transport, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, runtimeSchema, serverFieldsSchema, transportSchema };
|
|
1007
|
+
export { ApiContext, PLATFORM_LABELS, type Platform, RouterInput, RouterOutput, Runtime, Transport, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
package/dist/index.mjs
CHANGED
|
@@ -1,6 +1,398 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
1
2
|
import { oc } from "@orpc/contract";
|
|
2
3
|
import ms from "ms";
|
|
3
|
-
|
|
4
|
+
const platformSchema = z.enum(["chatgpt", "claudeai"]);
|
|
5
|
+
const PLATFORM_LABELS = {
|
|
6
|
+
chatgpt: "ChatGPT",
|
|
7
|
+
claudeai: "Claude.ai"
|
|
8
|
+
};
|
|
9
|
+
const auditStatusSchema = z.enum([
|
|
10
|
+
"pending",
|
|
11
|
+
"partial",
|
|
12
|
+
"completed",
|
|
13
|
+
"failed"
|
|
14
|
+
]);
|
|
15
|
+
const checkSeveritySchema = z.enum([
|
|
16
|
+
"error",
|
|
17
|
+
"warning",
|
|
18
|
+
"info"
|
|
19
|
+
]);
|
|
20
|
+
const checkCategorySchema = z.enum([
|
|
21
|
+
"connectivity",
|
|
22
|
+
"tool-metadata",
|
|
23
|
+
"resource-metadata",
|
|
24
|
+
"performance",
|
|
25
|
+
"e2e"
|
|
26
|
+
]);
|
|
27
|
+
const checkScopeSchema = z.enum(["server", "view"]);
|
|
28
|
+
const checkDetailSchema = z.object({
|
|
29
|
+
label: z.string(),
|
|
30
|
+
value: z.string().optional()
|
|
31
|
+
});
|
|
32
|
+
const checkResultSchema = z.object({
|
|
33
|
+
checkId: z.string(),
|
|
34
|
+
checkName: z.string(),
|
|
35
|
+
description: z.string(),
|
|
36
|
+
status: z.enum([
|
|
37
|
+
"pass",
|
|
38
|
+
"fail",
|
|
39
|
+
"skip",
|
|
40
|
+
"pending"
|
|
41
|
+
]),
|
|
42
|
+
message: z.string(),
|
|
43
|
+
skipReason: z.string().optional(),
|
|
44
|
+
severity: checkSeveritySchema,
|
|
45
|
+
category: checkCategorySchema,
|
|
46
|
+
scope: checkScopeSchema,
|
|
47
|
+
platforms: z.array(platformSchema).readonly().optional(),
|
|
48
|
+
durationMs: z.number(),
|
|
49
|
+
details: z.array(checkDetailSchema).optional(),
|
|
50
|
+
hint: z.object({ text: z.string() }).optional()
|
|
51
|
+
});
|
|
52
|
+
const auditReportSchema = z.object({
|
|
53
|
+
schemaVersion: z.string(),
|
|
54
|
+
auditId: z.string(),
|
|
55
|
+
targetUrl: z.string(),
|
|
56
|
+
startedAt: z.string(),
|
|
57
|
+
completedAt: z.string(),
|
|
58
|
+
durationMs: z.number(),
|
|
59
|
+
results: z.array(checkResultSchema),
|
|
60
|
+
requiresAuth: z.boolean(),
|
|
61
|
+
hasViewSupport: z.boolean(),
|
|
62
|
+
viewPlatforms: z.array(platformSchema).readonly().optional(),
|
|
63
|
+
isReadyForPlatform: z.record(platformSchema, z.boolean()),
|
|
64
|
+
widgetScreenshotKeys: z.object({
|
|
65
|
+
chatgpt: z.string().optional(),
|
|
66
|
+
claudeai: z.string().optional()
|
|
67
|
+
})
|
|
68
|
+
});
|
|
69
|
+
const widgetScreenshotSchema = z.object({ url: z.string() });
|
|
70
|
+
const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreenshots: z.object({
|
|
71
|
+
chatgpt: widgetScreenshotSchema.optional(),
|
|
72
|
+
claudeai: widgetScreenshotSchema.optional()
|
|
73
|
+
}) });
|
|
74
|
+
z.object({
|
|
75
|
+
id: z.string(),
|
|
76
|
+
createdAt: z.coerce.date(),
|
|
77
|
+
environmentId: z.string(),
|
|
78
|
+
content: z.string(),
|
|
79
|
+
source: z.enum(["model", "user"])
|
|
80
|
+
});
|
|
81
|
+
z.object({
|
|
82
|
+
content: z.string(),
|
|
83
|
+
source: z.enum(["model", "user"])
|
|
84
|
+
});
|
|
85
|
+
const toolDefinitionSchema = z.object({
|
|
86
|
+
name: z.string(),
|
|
87
|
+
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
88
|
+
description: z.string().optional(),
|
|
89
|
+
annotations: z.object({
|
|
90
|
+
readOnlyHint: z.boolean().optional(),
|
|
91
|
+
destructiveHint: z.boolean().optional(),
|
|
92
|
+
openWorldHint: z.boolean().optional(),
|
|
93
|
+
idempotentHint: z.boolean().optional()
|
|
94
|
+
}).optional()
|
|
95
|
+
});
|
|
96
|
+
const positiveTestCaseSchema = z.object({
|
|
97
|
+
scenario: z.string(),
|
|
98
|
+
userPrompt: z.string(),
|
|
99
|
+
toolTriggered: z.string().optional(),
|
|
100
|
+
expectedOutput: z.string().optional()
|
|
101
|
+
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
102
|
+
/** Accepts either a valid email or URL. */
|
|
103
|
+
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
104
|
+
const chatgptCategorySchema = z.enum([
|
|
105
|
+
"BUSINESS",
|
|
106
|
+
"COLLABORATION",
|
|
107
|
+
"DESIGN",
|
|
108
|
+
"DEVELOPER_TOOLS",
|
|
109
|
+
"EDUCATION",
|
|
110
|
+
"ENTERTAINMENT",
|
|
111
|
+
"FINANCE",
|
|
112
|
+
"FOOD",
|
|
113
|
+
"LIFESTYLE",
|
|
114
|
+
"NEWS",
|
|
115
|
+
"PRODUCTIVITY",
|
|
116
|
+
"SHOPPING",
|
|
117
|
+
"TRAVEL"
|
|
118
|
+
]);
|
|
119
|
+
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
120
|
+
const chatgptAllowedCountriesSchema = z.enum(["Allow all", "Restrict to specific countries"]);
|
|
121
|
+
const negativeTestCaseSchema = z.object({
|
|
122
|
+
scenario: z.string(),
|
|
123
|
+
userPrompt: z.string()
|
|
124
|
+
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
125
|
+
const chatgptToolJustificationSchema = z.object({
|
|
126
|
+
toolName: z.string(),
|
|
127
|
+
readOnlyJustification: z.string(),
|
|
128
|
+
openWorldJustification: z.string(),
|
|
129
|
+
destructiveJustification: z.string()
|
|
130
|
+
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
131
|
+
const chatgptTranslationSchema = z.object({
|
|
132
|
+
locale: z.string(),
|
|
133
|
+
tagline: z.string().optional(),
|
|
134
|
+
description: z.string().optional()
|
|
135
|
+
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
136
|
+
/**
|
|
137
|
+
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
138
|
+
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
139
|
+
*/
|
|
140
|
+
const chatgptSubmissionFormDataSchema = z.object({
|
|
141
|
+
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
142
|
+
logoDark: z.string().describe("Logo icon for dark mode. Square PNG. Same specs as the light icon."),
|
|
143
|
+
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
144
|
+
tagline: z.string().max(30).describe("Plain-language phrase focused on function and user value. 30 chars max."),
|
|
145
|
+
description: z.string().describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
|
|
146
|
+
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
147
|
+
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
148
|
+
companyUrl: z.url().describe("Your company's main website URL."),
|
|
149
|
+
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
150
|
+
privacyPolicyUrl: z.url().describe("URL to your privacy policy."),
|
|
151
|
+
termsOfServiceUrl: z.url().describe("URL to the app's terms of service."),
|
|
152
|
+
demoRecordingUrl: z.url().describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
153
|
+
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My app links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the app does not offer digital goods."),
|
|
154
|
+
serverUrl: z.url().describe("URL of the MCP server."),
|
|
155
|
+
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
156
|
+
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
157
|
+
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
158
|
+
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Coverage over all major use cases."),
|
|
159
|
+
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases — prompts where the app should NOT trigger but the model might think it's relevant."),
|
|
160
|
+
screenshots: z.array(z.url()).describe("URLs of in-app screenshots. Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 4. First three are public."),
|
|
161
|
+
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
162
|
+
allowedCountries: chatgptAllowedCountriesSchema.describe("'Allow all' or restrict to a specific list. See OpenAI's supported countries list."),
|
|
163
|
+
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
164
|
+
});
|
|
165
|
+
chatgptSubmissionFormDataSchema.pick({
|
|
166
|
+
appName: true,
|
|
167
|
+
developerName: true,
|
|
168
|
+
serverUrl: true,
|
|
169
|
+
tools: true,
|
|
170
|
+
authentication: true
|
|
171
|
+
});
|
|
172
|
+
chatgptSubmissionFormDataSchema.pick({
|
|
173
|
+
tagline: true,
|
|
174
|
+
description: true,
|
|
175
|
+
category: true,
|
|
176
|
+
testCases: true,
|
|
177
|
+
negativeTestCases: true,
|
|
178
|
+
toolJustifications: true
|
|
179
|
+
});
|
|
180
|
+
const claudeCategorySchema = z.enum([
|
|
181
|
+
"Business & Productivity",
|
|
182
|
+
"Communication",
|
|
183
|
+
"Data & Analytics",
|
|
184
|
+
"Development tools",
|
|
185
|
+
"Financial Services",
|
|
186
|
+
"Consumer Health",
|
|
187
|
+
"Health & Life Sciences",
|
|
188
|
+
"Media & Entertainment",
|
|
189
|
+
"Commerce & Shopping"
|
|
190
|
+
]);
|
|
191
|
+
z.enum([
|
|
192
|
+
"No auth needed",
|
|
193
|
+
"OAuth 2.0",
|
|
194
|
+
"Custom URL"
|
|
195
|
+
]);
|
|
196
|
+
const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
|
|
197
|
+
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
198
|
+
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
199
|
+
"Read only",
|
|
200
|
+
"Write only",
|
|
201
|
+
"Read + write"
|
|
202
|
+
]);
|
|
203
|
+
const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
|
|
204
|
+
const claudeThirdPartySchema = z.enum([
|
|
205
|
+
"Web access (open web fetch / scraping / arbitrary URLs)",
|
|
206
|
+
"Third-party AI model integration",
|
|
207
|
+
"Third-party data retrieval (via workflow / aggregator)",
|
|
208
|
+
"Third-party data modification (via workflow / aggregator)",
|
|
209
|
+
"N/A"
|
|
210
|
+
]);
|
|
211
|
+
const claudeDataHandlingSchema = z.enum([
|
|
212
|
+
"Server only accesses data explicitly requested by user",
|
|
213
|
+
"No data is stored beyond session requirements",
|
|
214
|
+
"Data transmission is encrypted (HTTPS / TLS)",
|
|
215
|
+
"GDPR compliant (if applicable)"
|
|
216
|
+
]);
|
|
217
|
+
const claudeSponsoredContentSchema = z.enum([
|
|
218
|
+
"No, there is no sponsored content or advertisements",
|
|
219
|
+
"Yes, there are banner ads or other paid visual elements",
|
|
220
|
+
"Yes, returned content or ranking is impacted by sponsorship or ad placement"
|
|
221
|
+
]);
|
|
222
|
+
/**
|
|
223
|
+
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
224
|
+
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
225
|
+
*/
|
|
226
|
+
const claudeSubmissionFormDataSchema = z.object({
|
|
227
|
+
companyName: z.string().describe("Enter your company's legal name or the name under which your product is publicly known. This is used for internal tracking and may appear in directory listings."),
|
|
228
|
+
companyUrl: z.url().describe("Your company's main website URL, e.g. https://mycompany.com. Must be a valid URL with https://. This should be the root domain of the company behind this MCP server."),
|
|
229
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. This person will receive review feedback, approval notices, and any follow-up questions."),
|
|
230
|
+
primaryContactEmail: z.email().describe("Business email for the primary contact. Must be a valid email address. Anthropic uses this to communicate about your submission status, required changes, and post-listing issues. Avoid using personal email addresses."),
|
|
231
|
+
primaryContactRole: z.string().optional().describe("The job title or role of the primary contact (e.g. 'CTO', 'Developer Relations Lead', 'Founder'). Optional but helps Anthropic route questions to the right person."),
|
|
232
|
+
anthropicPointOfContact: z.string().optional().describe("If you have a direct contact at Anthropic (e.g. from a partnership or sales conversation), enter their name here. This is optional but can greatly help expedite the review process. Leave blank if you don't have one."),
|
|
233
|
+
appName: z.string().describe(`The public display name for your connector as it will appear in the Connectors Directory.
|
|
234
|
+
|
|
235
|
+
Rules:
|
|
236
|
+
(1) Do NOT include the words 'MCP' or 'Server' — these are auto-rejected.
|
|
237
|
+
(2) Use your brand/product name, e.g. 'Notion', 'Linear', 'Slack'.
|
|
238
|
+
(3) You must own or have the right to use this brand name. For example, don't call it 'Google Drive Helper' if you're not Google.`),
|
|
239
|
+
mcpUrlType: claudeMcpUrlTypeSchema.describe(`Choose how your server URL works:
|
|
240
|
+
• 'Universal URL': one single URL that all users connect to (most common). Example: https://mcp.myapp.com
|
|
241
|
+
• 'Custom MCP URLs': each user gets their own unique URL (e.g. based on their workspace or instance).
|
|
242
|
+
If you choose this, you'll need to provide both a signup URL and a regex pattern that matches valid server URLs for your service.`),
|
|
243
|
+
serverUrl: z.url().describe(`If 'Universal URL': enter the full https:// URL where your MCP server is hosted and reachable. Example: https://mcp.myapp.com/
|
|
244
|
+
If 'Custom MCP URLs': provide (1) the signup/onboarding URL where users create an account, and (2) a regex pattern that matches all valid server URLs for your service (e.g. https://[a-z0-9-]+\\.myapp\\.com/mcp). The server must be publicly accessible without VPN or whitelisting required.`),
|
|
245
|
+
tagline: z.string().max(55).describe(`A very short, punchy description shown below your server name in the directory listing. Max 55 characters including spaces.
|
|
246
|
+
Think of it as a subtitle or elevator pitch fragment. Example: 'Manage tasks and projects in Linear' or 'Search and read your Notion workspace'. Avoid generic phrases like 'The best MCP server for...'`),
|
|
247
|
+
description: z.string().describe(`A 50–100 word description of what your MCP server does. This appears in the connector's detail page inside Claude. Write it from a user perspective: what can users do with this connector? What are the key features/tools? Avoid marketing fluff. Be specific. Example: 'Connect Claude to your Linear workspace. Create and update issues, search projects, manage teams, and track engineering cycles, all from within Claude.' Anthropic reviewers check this for accuracy against your actual tools.`),
|
|
248
|
+
testCases: z.array(positiveTestCaseSchema).describe(`Provide at least 3 concrete use cases, each with an example prompt a user could type to Claude. These are critical: Anthropic reviewers literally test your server using these prompts. Good examples are specific and demonstrate real value.
|
|
249
|
+
Best format: [Use case]: [exact prompt]"
|
|
250
|
+
Example for a task manager:
|
|
251
|
+
1. Create a task: 'Create a task called Review Q3 report, due Friday, assigned to Alice'
|
|
252
|
+
2. Search tasks: 'Show me all open bugs in the Mobile project'
|
|
253
|
+
3. Update status: 'Mark the Deploy v2.1 task as done'"`),
|
|
254
|
+
connectionRequirements: z.string().describe(`Describe any prerequisites a user must have before they can connect your server. Be exhaustive. Examples of things to mention:
|
|
255
|
+
• Account type required (free vs paid plan)
|
|
256
|
+
• Admin permissions or specific roles needed
|
|
257
|
+
• Geographic restrictions (e.g. 'US only' or 'Not available in EU')
|
|
258
|
+
• If users need to provide their own server URL or instance domain
|
|
259
|
+
• Any setup steps needed before connecting (e.g. 'Enable API access in your account settings')
|
|
260
|
+
If there are genuinely no special requirements, write exactly: 'No special requirements.'`),
|
|
261
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`Select the option that best describes what your server can do:
|
|
262
|
+
|
|
263
|
+
'Read Only': your tools only fetch/retrieve data (GET operations). Claude cannot modify anything via your server.
|
|
264
|
+
'Write Only': your tools only create/update/delete data (rare).
|
|
265
|
+
'Read + Write': your tools can both retrieve AND modify data (most common for full-featured connectors).
|
|
266
|
+
|
|
267
|
+
Note: Anthropic rejects catch-all tools that accept both safe (GET) and unsafe (POST, PUT, DELETE) HTTP methods via a parameter e.g. a single api_request(method, endpoint) tool. Each tool should have a fixed, specific purpose. `),
|
|
268
|
+
isMcpApp: z.boolean().describe(`Select 'Yes' if your MCP server renders interactive UI elements (aka widgets or views) inside the Claude conversation.
|
|
269
|
+
Select 'No' if your server only returns text/data responses.
|
|
270
|
+
If 'Yes', you will also be required to provide screenshots of your UI (see Promotional Images section). MCP Apps are displayed with a special badge in the directory.`),
|
|
271
|
+
thirdPartyConnectionsAndWebAccess: z.array(claudeThirdPartySchema).describe(`Multi-select all that apply to your server's behavior:
|
|
272
|
+
• 'Web access' — your server fetches arbitrary URLs, scrapes websites, or makes open-ended HTTP requests to the web (not just your own API).
|
|
273
|
+
• 'Third-party AI model integration' — your server calls another AI model (e.g. OpenAI, Gemini, Cohere) as part of its processing.
|
|
274
|
+
• 'Third-party data retrieval' — your server retrieves data via a workflow or aggregator platform (e.g. Zapier, Make, n8n) rather than calling your own API directly.
|
|
275
|
+
• 'Third-party data modification' — your server modifies data via such a platform.
|
|
276
|
+
• 'N/A' — your server only calls your own first-party API and does nothing else. Select this only if none of the above apply.`),
|
|
277
|
+
dataHandling: z.array(claudeDataHandlingSchema).describe(`Multi-select all data handling practices that accurately apply to your server. You must select at least 3. Key points:
|
|
278
|
+
• 'Server only accesses data explicitly requested by user' — your server doesn't silently read unrelated user data.
|
|
279
|
+
• 'No data is stored beyond session requirements' — you don't log or retain conversation data after the session.
|
|
280
|
+
• 'Data transmission is encrypted (HTTPS/TLS)' — all data in transit is encrypted. This should always apply for remote servers.
|
|
281
|
+
• 'GDPR compliant' — if you operate in the EU or serve EU users, check this only if you are genuinely compliant. Don't check it without having proper data processing agreements and procedures in place.
|
|
282
|
+
Note: These are attestations — you are legally agreeing to these practices by submitting the form.`),
|
|
283
|
+
personalDataHealthAccess: z.boolean().describe(`Select 'Yes' ONLY if your connector gives users access to their own personal health information — such as medical records, lab results, diagnoses, prescriptions, wearable health metrics (heart rate, sleep data, etc.), or mental health data.
|
|
284
|
+
Select 'No' for the vast majority of business/productivity/dev tools. When in doubt, select 'No'. This field triggers additional compliance review if 'Yes'.`),
|
|
285
|
+
categories: z.array(claudeCategorySchema).describe(`Select the category or categories that best describe your connector. This determines where it appears in the directory's browse experience. Choose the most specific fit:
|
|
286
|
+
• Business & Productivity — project management, CRM, HR, office tools
|
|
287
|
+
• Communication — email, chat, messaging, notifications
|
|
288
|
+
• Data & Analytics — dashboards, reporting, databases, BI tools
|
|
289
|
+
• Development tools — code repositories, CI/CD, issue trackers, monitoring
|
|
290
|
+
• Financial Services — accounting, invoicing, fintech (note: financial transaction execution is not permitted)
|
|
291
|
+
• Consumer Health — fitness, wellness, personal health tracking
|
|
292
|
+
• Health & Life Sciences — clinical, pharma, medical professional tools
|
|
293
|
+
• Media & Entertainment — content, publishing, streaming
|
|
294
|
+
• Commerce & Shopping — e-commerce, inventory, orders
|
|
295
|
+
Multiple categories are allowed if genuinely applicable.`),
|
|
296
|
+
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:
|
|
297
|
+
• '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.
|
|
298
|
+
• '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.
|
|
299
|
+
• '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.
|
|
300
|
+
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'.`),
|
|
301
|
+
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
302
|
+
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
303
|
+
• '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.
|
|
304
|
+
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
305
|
+
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:
|
|
306
|
+
• What the connector does and its key capabilities
|
|
307
|
+
• How to connect/set it up (step by step)
|
|
308
|
+
• What each tool does (or at least the main ones)
|
|
309
|
+
• How to troubleshoot common issues
|
|
310
|
+
• A support contact or channel
|
|
311
|
+
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.`),
|
|
312
|
+
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:
|
|
313
|
+
• What data you collect (and how)
|
|
314
|
+
• How you use the collected data
|
|
315
|
+
• Where and how long you store it
|
|
316
|
+
• Whether you share data with third parties (and who)
|
|
317
|
+
• How users can contact you about data concerns
|
|
318
|
+
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.`),
|
|
319
|
+
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:
|
|
320
|
+
• Email address (e.g. support@myapp.com)
|
|
321
|
+
• Link to a GitHub Issues page
|
|
322
|
+
• Link to a help center or support article
|
|
323
|
+
• Link to a Discord/Slack community
|
|
324
|
+
• Link to your documentation's troubleshooting section
|
|
325
|
+
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
326
|
+
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:
|
|
327
|
+
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
328
|
+
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
329
|
+
• 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.
|
|
330
|
+
• Credentials must remain valid for at least 30 days from submission.
|
|
331
|
+
• If your service requires API keys instead of a password, provide those.
|
|
332
|
+
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
333
|
+
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.
|
|
334
|
+
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
335
|
+
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.`),
|
|
336
|
+
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
337
|
+
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
338
|
+
• '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).
|
|
339
|
+
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.`),
|
|
340
|
+
logoLight: z.string().describe(`Your connector's logo as displayed in the directory. Requirements:
|
|
341
|
+
• Format: SVG only
|
|
342
|
+
• Aspect ratio: square (1:1)
|
|
343
|
+
• Should work on both light and dark backgrounds (or you can provide separate light/dark versions)
|
|
344
|
+
• Provide via URL (Google Drive link is fine) or upload directly
|
|
345
|
+
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
346
|
+
screenshots: z.array(z.url()).describe(`Screenshots or promotional images of your connector in action within Claude. Strongly recommended for all connectors, and required for MCP Apps (interactive UI). Guidelines:
|
|
347
|
+
• 3–5 images is ideal
|
|
348
|
+
• Minimum 1000px width, PNG format preferred
|
|
349
|
+
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
350
|
+
• Show your connector doing something impressive and useful — real data, real results
|
|
351
|
+
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
352
|
+
• Videos are also welcome
|
|
353
|
+
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
354
|
+
});
|
|
355
|
+
claudeSubmissionFormDataSchema.pick({
|
|
356
|
+
companyName: true,
|
|
357
|
+
appName: true,
|
|
358
|
+
mcpUrlType: true,
|
|
359
|
+
serverUrl: true,
|
|
360
|
+
tools: true,
|
|
361
|
+
readWriteCapabilities: true,
|
|
362
|
+
isMcpApp: true,
|
|
363
|
+
transportSupport: true,
|
|
364
|
+
primaryContactEmail: true,
|
|
365
|
+
primaryContactName: true
|
|
366
|
+
});
|
|
367
|
+
claudeSubmissionFormDataSchema.pick({
|
|
368
|
+
tagline: true,
|
|
369
|
+
description: true,
|
|
370
|
+
categories: true,
|
|
371
|
+
testCases: true
|
|
372
|
+
});
|
|
373
|
+
const submissionMetaFieldsSchema = z.object({
|
|
374
|
+
id: z.string(),
|
|
375
|
+
environmentId: z.string(),
|
|
376
|
+
createdAt: z.coerce.date(),
|
|
377
|
+
updatedAt: z.coerce.date()
|
|
378
|
+
});
|
|
379
|
+
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
380
|
+
platform: z.literal("claudeai"),
|
|
381
|
+
formData: claudeSubmissionFormDataSchema.partial()
|
|
382
|
+
});
|
|
383
|
+
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
384
|
+
platform: z.literal("chatgpt"),
|
|
385
|
+
formData: chatgptSubmissionFormDataSchema.partial()
|
|
386
|
+
});
|
|
387
|
+
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
388
|
+
z.union([claudeSubmissionFormDataSchema.partial(), chatgptSubmissionFormDataSchema.partial()]);
|
|
389
|
+
const subscriptionPlanSchema = z.enum([
|
|
390
|
+
"pro",
|
|
391
|
+
"business",
|
|
392
|
+
"enterprise"
|
|
393
|
+
]);
|
|
394
|
+
z.object({ plan: subscriptionPlanSchema.nullable() });
|
|
395
|
+
//#endregion
|
|
4
396
|
//#region src/schemas.ts
|
|
5
397
|
const RESERVED_KEYS = [
|
|
6
398
|
"_HANDLER",
|
|
@@ -35,7 +427,8 @@ const RESERVED_KEYS = [
|
|
|
35
427
|
"BUILD_ARG_BUILD_OUTPUT_DIR",
|
|
36
428
|
"BUILD_ARG_START_COMMAND",
|
|
37
429
|
"ALPIC_HOST",
|
|
38
|
-
"ALPIC_CUSTOM_DOMAINS"
|
|
430
|
+
"ALPIC_CUSTOM_DOMAINS",
|
|
431
|
+
"ALPIC_INTENT_META_KEY"
|
|
39
432
|
];
|
|
40
433
|
const environmentVariableSchema = z.object({
|
|
41
434
|
key: z.string().min(2, "Key must be at least 2 characters").regex(/^[a-zA-Z]([a-zA-Z0-9_])+$/, "Key must start with a letter and contain only letters, numbers, and underscores").refine((key) => !RESERVED_KEYS.includes(key), "This key is reserved and cannot be used as an environment variable key"),
|
|
@@ -43,6 +436,10 @@ const environmentVariableSchema = z.object({
|
|
|
43
436
|
isSecret: z.boolean().default(false)
|
|
44
437
|
});
|
|
45
438
|
const environmentVariablesSchema = z.array(environmentVariableSchema);
|
|
439
|
+
const updateEnvironmentVariableSchema = environmentVariableSchema.partial({
|
|
440
|
+
value: true,
|
|
441
|
+
isSecret: true
|
|
442
|
+
});
|
|
46
443
|
const buildSettingsSchema = z.object({
|
|
47
444
|
installCommand: z.string().optional(),
|
|
48
445
|
buildCommand: z.string().optional(),
|
|
@@ -60,6 +457,16 @@ const transportSchema = z.enum([
|
|
|
60
457
|
"sse",
|
|
61
458
|
"streamablehttp"
|
|
62
459
|
]);
|
|
460
|
+
const playgroundHeaderSchema = z.object({
|
|
461
|
+
name: z.string().min(1).max(100),
|
|
462
|
+
description: z.string().max(200),
|
|
463
|
+
isRequired: z.boolean().default(false),
|
|
464
|
+
isSecret: z.boolean().default(false)
|
|
465
|
+
});
|
|
466
|
+
const playgroundExamplePromptSchema = z.object({
|
|
467
|
+
title: z.string().min(1).max(100),
|
|
468
|
+
prompt: z.string().min(1).max(500)
|
|
469
|
+
});
|
|
63
470
|
const serverFieldsSchema = z.object({
|
|
64
471
|
$schema: z.string(),
|
|
65
472
|
name: z.string(),
|
|
@@ -298,7 +705,7 @@ const updateEnvironmentVariableContractV1 = oc.route({
|
|
|
298
705
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
299
706
|
key: environmentVariableSchema.shape.key,
|
|
300
707
|
value: environmentVariableSchema.shape.value.optional(),
|
|
301
|
-
isSecret: environmentVariableSchema.shape.isSecret
|
|
708
|
+
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
302
709
|
})).output(z.object({ success: z.literal(true) }));
|
|
303
710
|
const deleteEnvironmentVariableContractV1 = oc.route({
|
|
304
711
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
@@ -309,7 +716,7 @@ const deleteEnvironmentVariableContractV1 = oc.route({
|
|
|
309
716
|
successDescription: "The environment variable has been deleted successfully"
|
|
310
717
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
311
718
|
const deleteProjectContractV1 = oc.route({
|
|
312
|
-
path: "/v1/projects
|
|
719
|
+
path: "/v1/projects/{projectId}",
|
|
313
720
|
method: "DELETE",
|
|
314
721
|
summary: "Delete a project",
|
|
315
722
|
description: "Delete a project and all its environments",
|
|
@@ -418,6 +825,41 @@ const getLogsContractV1 = oc.route({
|
|
|
418
825
|
})),
|
|
419
826
|
nextToken: z.string().nullable()
|
|
420
827
|
}));
|
|
828
|
+
const getLatestLogsContractV1 = oc.route({
|
|
829
|
+
path: "/v1/environments/{environmentId}/latest-logs",
|
|
830
|
+
method: "GET",
|
|
831
|
+
summary: "Get latest logs",
|
|
832
|
+
description: "Get the N most recent logs for an environment",
|
|
833
|
+
tags: ["environments"],
|
|
834
|
+
successDescription: "The latest logs"
|
|
835
|
+
}).errors({
|
|
836
|
+
NOT_FOUND: {},
|
|
837
|
+
BAD_REQUEST: {}
|
|
838
|
+
}).input(z.object({
|
|
839
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
840
|
+
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
841
|
+
level: z.array(z.enum([
|
|
842
|
+
"INFO",
|
|
843
|
+
"ERROR",
|
|
844
|
+
"WARNING",
|
|
845
|
+
"DEBUG"
|
|
846
|
+
])).optional().describe("Filter by log level"),
|
|
847
|
+
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
848
|
+
})).output(z.object({ logs: z.array(z.object({
|
|
849
|
+
timestamp: z.coerce.date(),
|
|
850
|
+
type: z.enum([
|
|
851
|
+
"START",
|
|
852
|
+
"END",
|
|
853
|
+
"INFO",
|
|
854
|
+
"ERROR",
|
|
855
|
+
"WARNING",
|
|
856
|
+
"DEBUG"
|
|
857
|
+
]),
|
|
858
|
+
requestId: z.string(),
|
|
859
|
+
content: z.string().optional(),
|
|
860
|
+
method: z.string().optional(),
|
|
861
|
+
durationInMs: z.number().optional()
|
|
862
|
+
})) }));
|
|
421
863
|
const getDeploymentLogsContractV1 = oc.route({
|
|
422
864
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
423
865
|
method: "GET",
|
|
@@ -527,6 +969,78 @@ const getServerInfoContractV1 = oc.route({
|
|
|
527
969
|
projectId: z.string(),
|
|
528
970
|
domain: z.string()
|
|
529
971
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
972
|
+
const playgroundServerMetadataOutputSchema = z.object({
|
|
973
|
+
name: z.string(),
|
|
974
|
+
description: z.string(),
|
|
975
|
+
headers: z.array(z.object({
|
|
976
|
+
name: z.string(),
|
|
977
|
+
description: z.string(),
|
|
978
|
+
isRequired: z.boolean(),
|
|
979
|
+
isSecret: z.boolean()
|
|
980
|
+
})),
|
|
981
|
+
examplePrompts: z.array(playgroundExamplePromptSchema)
|
|
982
|
+
});
|
|
983
|
+
const playgroundOutputSchema = z.object({
|
|
984
|
+
isPlaygroundEnabled: z.boolean(),
|
|
985
|
+
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
986
|
+
});
|
|
987
|
+
const getPlaygroundContractV1 = oc.route({
|
|
988
|
+
path: "/v1/environments/{environmentId}/playground",
|
|
989
|
+
method: "GET",
|
|
990
|
+
summary: "Get playground configuration",
|
|
991
|
+
description: "Get the playground configuration for an environment",
|
|
992
|
+
tags: ["environments"],
|
|
993
|
+
successDescription: "The playground configuration"
|
|
994
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
995
|
+
const upsertPlaygroundContractV1 = oc.route({
|
|
996
|
+
path: "/v1/environments/{environmentId}/playground",
|
|
997
|
+
method: "PUT",
|
|
998
|
+
summary: "Update playground configuration",
|
|
999
|
+
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1000
|
+
tags: ["environments"],
|
|
1001
|
+
successDescription: "The updated playground configuration"
|
|
1002
|
+
}).errors({
|
|
1003
|
+
NOT_FOUND: {},
|
|
1004
|
+
BAD_REQUEST: {}
|
|
1005
|
+
}).input(z.object({
|
|
1006
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1007
|
+
isPlaygroundEnabled: z.boolean().optional(),
|
|
1008
|
+
name: z.string().min(1).max(100).optional(),
|
|
1009
|
+
description: z.string().min(1).max(500).optional(),
|
|
1010
|
+
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1011
|
+
examplePrompts: z.array(playgroundExamplePromptSchema).max(3).optional()
|
|
1012
|
+
})).output(playgroundOutputSchema);
|
|
1013
|
+
const createBeaconContractV1 = oc.route({
|
|
1014
|
+
path: "/v1/beacon/audits",
|
|
1015
|
+
method: "POST",
|
|
1016
|
+
summary: "Create a beacon audit",
|
|
1017
|
+
description: "Audit an MCP server for spec compliance and AI client compatibility",
|
|
1018
|
+
tags: ["beacon"],
|
|
1019
|
+
successDescription: "The audit has been created"
|
|
1020
|
+
}).errors({
|
|
1021
|
+
NOT_FOUND: {},
|
|
1022
|
+
BAD_REQUEST: {}
|
|
1023
|
+
}).input(z.object({
|
|
1024
|
+
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
1025
|
+
teamId: z.string().optional().describe("The team ID to associate the audit with"),
|
|
1026
|
+
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1027
|
+
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1028
|
+
})).output(z.object({ id: z.string() }));
|
|
1029
|
+
const getBeaconContractV1 = oc.route({
|
|
1030
|
+
path: "/v1/beacon/audits/{auditId}",
|
|
1031
|
+
method: "GET",
|
|
1032
|
+
summary: "Get a beacon audit",
|
|
1033
|
+
description: "Get a beacon audit by ID, including the report if completed",
|
|
1034
|
+
tags: ["beacon"],
|
|
1035
|
+
successDescription: "The audit details"
|
|
1036
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ auditId: z.string().describe("The ID of the audit") })).output(z.object({
|
|
1037
|
+
id: z.string(),
|
|
1038
|
+
targetUrl: z.string(),
|
|
1039
|
+
status: auditStatusSchema,
|
|
1040
|
+
durationMs: z.number().nullable(),
|
|
1041
|
+
createdAt: z.coerce.date(),
|
|
1042
|
+
report: auditReportWithScreenshotsSchema.nullable()
|
|
1043
|
+
}));
|
|
530
1044
|
const contract = {
|
|
531
1045
|
teams: { list: { v1: listTeamsContractV1 } },
|
|
532
1046
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
@@ -540,7 +1054,8 @@ const contract = {
|
|
|
540
1054
|
create: { v1: createEnvironmentContractV1 },
|
|
541
1055
|
get: { v1: getEnvironmentContractV1 },
|
|
542
1056
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
543
|
-
getLogs: { v1: getLogsContractV1 }
|
|
1057
|
+
getLogs: { v1: getLogsContractV1 },
|
|
1058
|
+
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
544
1059
|
},
|
|
545
1060
|
environmentVariables: {
|
|
546
1061
|
list: { v1: listEnvironmentVariablesContractV1 },
|
|
@@ -555,11 +1070,19 @@ const contract = {
|
|
|
555
1070
|
create: { v1: createProjectContractV1 },
|
|
556
1071
|
delete: { v1: deleteProjectContractV1 }
|
|
557
1072
|
},
|
|
1073
|
+
playground: {
|
|
1074
|
+
get: { v1: getPlaygroundContractV1 },
|
|
1075
|
+
upsert: { v1: upsertPlaygroundContractV1 }
|
|
1076
|
+
},
|
|
558
1077
|
tunnels: { getTicket: { v1: getTunnelTicketContractV1 } },
|
|
559
1078
|
distribution: {
|
|
560
1079
|
publish: { v1: publishServerContractV1 },
|
|
561
1080
|
get: { v1: getServerInfoContractV1 }
|
|
1081
|
+
},
|
|
1082
|
+
beacon: {
|
|
1083
|
+
create: { v1: createBeaconContractV1 },
|
|
1084
|
+
get: { v1: getBeaconContractV1 }
|
|
562
1085
|
}
|
|
563
1086
|
};
|
|
564
1087
|
//#endregion
|
|
565
|
-
export { buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, runtimeSchema, serverFieldsSchema, transportSchema };
|
|
1088
|
+
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@alpic-ai/api",
|
|
3
|
-
"version": "0.0.0-staging.
|
|
3
|
+
"version": "0.0.0-staging.fd696be",
|
|
4
4
|
"description": "Contract for the Alpic API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.mjs",
|
|
@@ -14,20 +14,32 @@
|
|
|
14
14
|
"files": [
|
|
15
15
|
"dist"
|
|
16
16
|
],
|
|
17
|
+
"nx": {
|
|
18
|
+
"targets": {
|
|
19
|
+
"build": {
|
|
20
|
+
"dependsOn": [
|
|
21
|
+
"^build"
|
|
22
|
+
]
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
},
|
|
17
26
|
"author": "Alpic",
|
|
18
27
|
"license": "ISC",
|
|
19
28
|
"dependencies": {
|
|
20
|
-
"@orpc/contract": "^1.
|
|
29
|
+
"@orpc/contract": "^1.14.3",
|
|
21
30
|
"ms": "^2.1.3",
|
|
22
|
-
"zod": "^4.3
|
|
31
|
+
"zod": "^4.4.3"
|
|
23
32
|
},
|
|
24
33
|
"devDependencies": {
|
|
34
|
+
"@orpc/openapi": "^1.14.3",
|
|
35
|
+
"@orpc/zod": "^1.14.3",
|
|
25
36
|
"@total-typescript/tsconfig": "^1.0.4",
|
|
26
37
|
"@types/ms": "^2.1.0",
|
|
27
38
|
"shx": "^0.4.0",
|
|
28
|
-
"tsdown": "^0.
|
|
29
|
-
"typescript": "^
|
|
30
|
-
"vitest": "^4.1.
|
|
39
|
+
"tsdown": "^0.22.0",
|
|
40
|
+
"typescript": "^6.0.3",
|
|
41
|
+
"vitest": "^4.1.6",
|
|
42
|
+
"@alpic-ai/domains": "0.0.0"
|
|
31
43
|
},
|
|
32
44
|
"scripts": {
|
|
33
45
|
"build": "shx rm -rf dist && tsdown",
|