1export const messagingGithubIntegrationSpec = defineIntegration({
2	meta: {
3		key: 'messaging.github',
4		version: '1.0.0',
5		category: 'messaging',
6		title: 'GitHub Messaging Bridge',
7		description:
8			'GitHub integration for issue and pull request comment workflows backed by webhook events.',
9		domain: 'developer-experience',
10		owners: ['platform.messaging'],
11		tags: ['messaging', 'github', 'pull-requests'],
12		stability: StabilityEnum.Beta,
13	},
14	supportedModes: ['managed', 'byok'],
15	transports: [
16		{
17			type: 'rest',
18			baseUrl: 'https://api.github.com',
19			apiVersionHeader: 'X-GitHub-Api-Version',
20		},
21		{
22			type: 'webhook',
23			inbound: {
24				signatureHeader: 'x-hub-signature-256',
25				signingAlgorithm: 'hmac-sha256',
26			},
27		},
28	],
29	preferredTransport: 'rest',
30	supportedAuthMethods: [
31		{ type: 'bearer' },
32		{
33			type: 'oauth2',
34			grantType: 'authorization_code',
35			authorizationUrl: 'https://github.com/login/oauth/authorize',
36			tokenUrl: 'https://github.com/login/oauth/access_token',
37			scopes: ['repo', 'read:org'],
38		},
39		{
40			type: 'webhook-signing',
41			algorithm: 'hmac-sha256',
42			signatureHeader: 'x-hub-signature-256',
43		},
44	],
45	versionPolicy: {
46		currentVersion: '2022-11-28',
47		supportedVersions: [{ version: '2022-11-28', status: 'stable' }],
48		versionHeader: 'X-GitHub-Api-Version',
49	},
50	capabilities: {
51		provides: [
52			{ key: 'messaging.inbound', version: '1.0.0' },
53			{ key: 'messaging.outbound', version: '1.0.0' },
54		],
55	},
56	configSchema: {
57		schema: {
58			type: 'object',
59			properties: {
60				defaultOwner: {
61					type: 'string',
62					description: 'Optional default GitHub repository owner.',
63				},
64				defaultRepo: {
65					type: 'string',
66					description: 'Optional default GitHub repository name.',
67				},
68				apiBaseUrl: {
69					type: 'string',
70					description:
71						'Optional GitHub REST API base URL (useful for enterprise instances).',
72				},
73			},
74		},
75		example: {
76			defaultOwner: 'lssm-tech',
77			defaultRepo: 'contractspec',
78		},
79	},
80	secretSchema: {
81		schema: {
82			type: 'object',
83			required: ['token', 'webhookSecret'],
84			properties: {
85				token: {
86					type: 'string',
87					description:
88						'GitHub API token used to post comments and automation messages.',
89				},
90				webhookSecret: {
91					type: 'string',
92					description:
93						'Secret used to verify inbound GitHub webhook signatures.',
94				},
95			},
96		},
97		example: {
98			token: 'ghp_***',
99			webhookSecret: '***',
100		},
101	},
102	healthCheck: {
103		method: 'custom',
104		timeoutMs: 4000,
105	},
106	docsUrl: 'https://docs.github.com/en/rest',
107	constraints: {
108		rateLimit: {
109			rpm: 300,
110		},
111	},
112	byokSetup: {
113		setupInstructions:
114			'Create a GitHub token or app installation token with repository access and configure the webhook secret.',
115		requiredScopes: ['repo', 'read:org'],
116		keyRotationSupported: true,
117		quotaTrackingSupported: false,
118	},
119});