-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathvercel.zod.ts
More file actions
645 lines (551 loc) · 15.4 KB
/
vercel.zod.ts
File metadata and controls
645 lines (551 loc) · 15.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
import { z } from 'zod';
import {
ConnectorSchema,
} from '../connector.zod';
/**
* Vercel Connector Protocol
*
* Specialized connector for Vercel deployment platform enabling automated
* deployments, preview environments, and production releases.
*
* Use Cases:
* - Automated deployments from Git
* - Preview deployments for pull requests
* - Production releases
* - Environment variable management
* - Domain and SSL configuration
* - Edge function deployment
*
* @example
* ```typescript
* import { VercelConnector } from '@objectstack/spec/integration';
*
* const vercelConnector: VercelConnector = {
* name: 'vercel_production',
* label: 'Vercel Production',
* type: 'saas',
* provider: 'vercel',
* baseUrl: 'https://api.vercel.com',
* authentication: {
* type: 'bearer',
* token: '${VERCEL_TOKEN}',
* },
* projects: [
* {
* name: 'objectstack-app',
* framework: 'nextjs',
* gitRepository: {
* type: 'github',
* repo: 'objectstack-ai/app',
* },
* },
* ],
* };
* ```
*/
/**
* Vercel Provider Type
*/
import { lazySchema } from '../../shared/lazy-schema';
export const VercelProviderSchema = lazySchema(() => z.enum([
'vercel',
]).describe('Vercel provider type'));
export type VercelProvider = z.infer<typeof VercelProviderSchema>;
/**
* Vercel Framework Types
*/
export const VercelFrameworkSchema = lazySchema(() => z.enum([
'nextjs',
'react',
'vue',
'nuxtjs',
'gatsby',
'remix',
'astro',
'sveltekit',
'solid',
'angular',
'static',
'other',
]).describe('Frontend framework'));
export type VercelFramework = z.infer<typeof VercelFrameworkSchema>;
/**
* Git Repository Configuration
*/
export const GitRepositoryConfigSchema = lazySchema(() => z.object({
/**
* Git provider type
*/
type: z.enum(['github', 'gitlab', 'bitbucket']).describe('Git provider'),
/**
* Repository identifier (owner/repo)
*/
repo: z.string().describe('Repository identifier (e.g., owner/repo)'),
/**
* Production branch
*/
productionBranch: z.string().optional().default('main').describe('Production branch name'),
/**
* Auto-deploy production branch
*/
autoDeployProduction: z.boolean().optional().default(true).describe('Auto-deploy production branch'),
/**
* Auto-deploy preview branches
*/
autoDeployPreview: z.boolean().optional().default(true).describe('Auto-deploy preview branches'),
}));
export type GitRepositoryConfig = z.infer<typeof GitRepositoryConfigSchema>;
/**
* Build Configuration
*/
export const BuildConfigSchema = lazySchema(() => z.object({
/**
* Build command
*/
buildCommand: z.string().optional().describe('Build command (e.g., npm run build)'),
/**
* Output directory
*/
outputDirectory: z.string().optional().describe('Output directory (e.g., .next, dist)'),
/**
* Install command
*/
installCommand: z.string().optional().describe('Install command (e.g., npm install, pnpm install)'),
/**
* Development command
*/
devCommand: z.string().optional().describe('Development command (e.g., npm run dev)'),
/**
* Node.js version
*/
nodeVersion: z.string().optional().describe('Node.js version (e.g., 18.x, 20.x)'),
/**
* Environment variables
*/
env: z.record(z.string(), z.string()).optional().describe('Build environment variables'),
}));
export type BuildConfig = z.infer<typeof BuildConfigSchema>;
/**
* Deployment Configuration
*/
export const DeploymentConfigSchema = lazySchema(() => z.object({
/**
* Enable automatic deployments
*/
autoDeployment: z.boolean().optional().default(true).describe('Enable automatic deployments'),
/**
* Deployment regions
*/
regions: z.array(z.enum([
'iad1', // US East (Washington, D.C.)
'sfo1', // US West (San Francisco)
'gru1', // South America (São Paulo)
'lhr1', // Europe West (London)
'fra1', // Europe Central (Frankfurt)
'sin1', // Asia (Singapore)
'syd1', // Australia (Sydney)
'hnd1', // Asia (Tokyo)
'icn1', // Asia (Seoul)
])).optional().describe('Deployment regions'),
/**
* Enable preview deployments
*/
enablePreview: z.boolean().optional().default(true).describe('Enable preview deployments'),
/**
* Preview deployment comments on PRs
*/
previewComments: z.boolean().optional().default(true).describe('Post preview URLs in PR comments'),
/**
* Production deployment protection
*/
productionProtection: z.boolean().optional().default(true).describe('Require approval for production deployments'),
/**
* Deploy hooks
*/
deployHooks: z.array(z.object({
name: z.string().describe('Hook name'),
url: z.string().url().describe('Deploy hook URL'),
branch: z.string().optional().describe('Target branch'),
})).optional().describe('Deploy hooks'),
}));
export type DeploymentConfig = z.infer<typeof DeploymentConfigSchema>;
/**
* Domain Configuration
*/
export const DomainConfigSchema = lazySchema(() => z.object({
/**
* Domain name
*/
domain: z.string().describe('Domain name (e.g., app.example.com)'),
/**
* Enable HTTPS redirect
*/
httpsRedirect: z.boolean().optional().default(true).describe('Redirect HTTP to HTTPS'),
/**
* Custom SSL certificate
*/
customCertificate: z.object({
cert: z.string().describe('SSL certificate'),
key: z.string().describe('Private key'),
ca: z.string().optional().describe('Certificate authority'),
}).optional().describe('Custom SSL certificate'),
/**
* Git branch for this domain
*/
gitBranch: z.string().optional().describe('Git branch to deploy to this domain'),
}));
export type DomainConfig = z.infer<typeof DomainConfigSchema>;
/**
* Environment Variables Configuration
*/
export const EnvironmentVariablesSchema = lazySchema(() => z.object({
/**
* Variable name
*/
key: z.string().describe('Environment variable name'),
/**
* Variable value
*/
value: z.string().describe('Environment variable value'),
/**
* Target environments
*/
target: z.array(z.enum(['production', 'preview', 'development'])).describe('Target environments'),
/**
* Is secret (encrypted)
*/
isSecret: z.boolean().optional().default(false).describe('Encrypt this variable'),
/**
* Git branch (for preview/development)
*/
gitBranch: z.string().optional().describe('Specific git branch'),
}));
export type EnvironmentVariables = z.infer<typeof EnvironmentVariablesSchema>;
/**
* Edge Function Configuration
*/
export const EdgeFunctionConfigSchema = lazySchema(() => z.object({
/**
* Function name
*/
name: z.string().describe('Edge function name'),
/**
* Function path
*/
path: z.string().describe('Function path (e.g., /api/*)'),
/**
* Regions to deploy
*/
regions: z.array(z.string()).optional().describe('Specific regions for this function'),
/**
* Memory limit (MB)
*/
memoryLimit: z.number().int().min(128).max(3008).optional().default(1024).describe('Memory limit in MB'),
/**
* Timeout (seconds)
*/
timeout: z.number().int().min(1).max(300).optional().default(10).describe('Timeout in seconds'),
}));
export type EdgeFunctionConfig = z.infer<typeof EdgeFunctionConfigSchema>;
/**
* Vercel Project Configuration
*/
export const VercelProjectSchema = lazySchema(() => z.object({
/**
* Project name
*/
name: z.string().describe('Vercel project name'),
/**
* Framework
*/
framework: VercelFrameworkSchema.optional().describe('Frontend framework'),
/**
* Git repository
*/
gitRepository: GitRepositoryConfigSchema.optional().describe('Git repository configuration'),
/**
* Build configuration
*/
buildConfig: BuildConfigSchema.optional().describe('Build configuration'),
/**
* Deployment configuration
*/
deploymentConfig: DeploymentConfigSchema.optional().describe('Deployment configuration'),
/**
* Custom domains
*/
domains: z.array(DomainConfigSchema).optional().describe('Custom domains'),
/**
* Environment variables
*/
environmentVariables: z.array(EnvironmentVariablesSchema).optional().describe('Environment variables'),
/**
* Edge functions
*/
edgeFunctions: z.array(EdgeFunctionConfigSchema).optional().describe('Edge functions'),
/**
* Root directory
*/
rootDirectory: z.string().optional().describe('Root directory (for monorepos)'),
}));
export type VercelProject = z.infer<typeof VercelProjectSchema>;
/**
* Vercel Monitoring Configuration
*/
export const VercelMonitoringSchema = lazySchema(() => z.object({
/**
* Enable Web Analytics
*/
enableWebAnalytics: z.boolean().optional().default(false).describe('Enable Vercel Web Analytics'),
/**
* Enable Speed Insights
*/
enableSpeedInsights: z.boolean().optional().default(false).describe('Enable Vercel Speed Insights'),
/**
* Enable Log Drains
*/
logDrains: z.array(z.object({
name: z.string().describe('Log drain name'),
url: z.string().url().describe('Log drain URL'),
headers: z.record(z.string(), z.string()).optional().describe('Custom headers'),
sources: z.array(z.enum(['static', 'lambda', 'edge'])).optional().describe('Log sources'),
})).optional().describe('Log drains configuration'),
}));
export type VercelMonitoring = z.infer<typeof VercelMonitoringSchema>;
/**
* Vercel Team Configuration
*/
export const VercelTeamSchema = lazySchema(() => z.object({
/**
* Team ID or slug
*/
teamId: z.string().optional().describe('Team ID or slug'),
/**
* Team name
*/
teamName: z.string().optional().describe('Team name'),
}));
export type VercelTeam = z.infer<typeof VercelTeamSchema>;
/**
* Vercel Connector Schema
* Complete Vercel integration configuration
*/
export const VercelConnectorSchema = lazySchema(() => ConnectorSchema.extend({
type: z.literal('saas'),
/**
* Vercel provider
*/
provider: VercelProviderSchema.describe('Vercel provider'),
/**
* Vercel API base URL
*/
baseUrl: z.string().url().optional().default('https://api.vercel.com').describe('Vercel API base URL'),
/**
* Team configuration
*/
team: VercelTeamSchema.optional().describe('Vercel team configuration'),
/**
* Projects to manage
*/
projects: z.array(VercelProjectSchema).describe('Vercel projects'),
/**
* Monitoring configuration
*/
monitoring: VercelMonitoringSchema.optional().describe('Monitoring configuration'),
/**
* Enable webhooks
*/
enableWebhooks: z.boolean().optional().default(true).describe('Enable Vercel webhooks'),
/**
* Webhook events to subscribe
*/
webhookEvents: z.array(z.enum([
'deployment.created',
'deployment.succeeded',
'deployment.failed',
'deployment.ready',
'deployment.error',
'deployment.canceled',
'deployment-checks-completed',
'deployment-prepared',
'project.created',
'project.removed',
])).optional().describe('Webhook events to subscribe to'),
}));
export type VercelConnector = z.infer<typeof VercelConnectorSchema>;
// ============================================================================
// Helper Functions & Examples
// ============================================================================
/**
* Example: Vercel Next.js Project Configuration
*/
export const vercelNextJsConnectorExample = {
name: 'vercel_production',
label: 'Vercel Production',
type: 'saas',
provider: 'vercel',
baseUrl: 'https://api.vercel.com',
authentication: {
type: 'bearer',
token: '${VERCEL_TOKEN}',
},
projects: [
{
name: 'objectstack-app',
framework: 'nextjs',
gitRepository: {
type: 'github',
repo: 'objectstack-ai/app',
productionBranch: 'main',
autoDeployProduction: true,
autoDeployPreview: true,
},
buildConfig: {
buildCommand: 'npm run build',
outputDirectory: '.next',
installCommand: 'npm ci',
devCommand: 'npm run dev',
nodeVersion: '20.x',
env: {
NEXT_PUBLIC_API_URL: 'https://api.objectstack.ai',
},
},
deploymentConfig: {
autoDeployment: true,
regions: ['iad1', 'sfo1', 'fra1'],
enablePreview: true,
previewComments: true,
productionProtection: true,
},
domains: [
{
domain: 'app.objectstack.ai',
httpsRedirect: true,
gitBranch: 'main',
},
{
domain: 'staging.objectstack.ai',
httpsRedirect: true,
gitBranch: 'develop',
},
],
environmentVariables: [
{
key: 'DATABASE_URL',
value: '${DATABASE_URL}',
target: ['production', 'preview'],
isSecret: true,
},
{
key: 'NEXT_PUBLIC_ANALYTICS_ID',
value: 'UA-XXXXXXXX-X',
target: ['production'],
isSecret: false,
},
],
edgeFunctions: [
{
name: 'api-middleware',
path: '/api/*',
regions: ['iad1', 'sfo1'],
memoryLimit: 1024,
timeout: 10,
},
],
},
],
monitoring: {
enableWebAnalytics: true,
enableSpeedInsights: true,
logDrains: [
{
name: 'datadog-logs',
url: 'https://http-intake.logs.datadoghq.com/api/v2/logs',
headers: {
'DD-API-KEY': '${DATADOG_API_KEY}',
},
sources: ['lambda', 'edge'],
},
],
},
enableWebhooks: true,
webhookEvents: [
'deployment.succeeded',
'deployment.failed',
'deployment.ready',
],
status: 'active',
enabled: true,
};
/**
* Example: Vercel Static Site Configuration
*/
export const vercelStaticSiteConnectorExample = {
name: 'vercel_docs',
label: 'Vercel Documentation',
type: 'saas',
provider: 'vercel',
baseUrl: 'https://api.vercel.com',
authentication: {
type: 'bearer',
token: '${VERCEL_TOKEN}',
},
team: {
teamId: 'team_xxxxxx',
teamName: 'ObjectStack',
},
projects: [
{
name: 'objectstack-docs',
framework: 'static',
gitRepository: {
type: 'github',
repo: 'objectstack-ai/docs',
productionBranch: 'main',
autoDeployProduction: true,
autoDeployPreview: true,
},
buildConfig: {
buildCommand: 'npm run build',
outputDirectory: 'dist',
installCommand: 'npm ci',
nodeVersion: '18.x',
},
deploymentConfig: {
autoDeployment: true,
regions: ['iad1', 'lhr1', 'sin1'],
enablePreview: true,
previewComments: true,
productionProtection: false,
},
domains: [
{
domain: 'docs.objectstack.ai',
httpsRedirect: true,
},
],
environmentVariables: [
{
key: 'ALGOLIA_APP_ID',
value: '${ALGOLIA_APP_ID}',
target: ['production', 'preview'],
isSecret: false,
},
{
key: 'ALGOLIA_API_KEY',
value: '${ALGOLIA_API_KEY}',
target: ['production', 'preview'],
isSecret: true,
},
],
},
],
monitoring: {
enableWebAnalytics: true,
enableSpeedInsights: false,
},
enableWebhooks: false,
status: 'active',
enabled: true,
};