✨ Add server webhooks (#4)

Author: NatoBoram

src/server/index.ts

@@ -1,2 +1,3 @@
 export * from "./client.js"
-export * as server from "./openapi/index.js"
+export * from "./openapi/index.js"
+export * from "./webhooks/index.js"

src/server/webhooks/events/event.ts

@@ -0,0 +1,9 @@
+import type { PrEvent } from "./pr/event.js"
+import type { ProjectEvent } from "./project/event.js"
+import type { RepoEvent } from "./repo/event.js"
+
+export type Event = PrEvent | ProjectEvent | RepoEvent
+export type EventKey =
+	| PrEvent["eventKey"]
+	| ProjectEvent["eventKey"]
+	| RepoEvent["eventKey"]

src/server/webhooks/events/index.ts

@@ -0,0 +1,4 @@
+export * from "./event.js"
+export * as pr from "./pr/index.js"
+export * as project from "./project/index.js"
+export * as repo from "./repo/index.js"

src/server/webhooks/events/pr/comment_added.ts

@@ -0,0 +1,91 @@
+export interface Actor {
+	readonly active: boolean
+	readonly displayName: string
+	readonly emailAddress: string
+	readonly id: number
+	readonly name: string
+	readonly slug: string
+	readonly type: string
+}
+
+export interface Author {
+	readonly approved: boolean
+	readonly role: string
+	readonly status: string
+	readonly user: Actor
+}
+
+export interface Comment {
+	readonly author: Actor
+	readonly comments: unknown[]
+	readonly createdDate: number
+	readonly id: number
+	readonly properties: Properties
+	readonly tasks: unknown[]
+	readonly text: string
+	readonly updatedDate: number
+	readonly version: number
+}
+
+/** A user comments on a pull request. This payload comes with an event key of `pr:comment:added`. */
+export interface PRCommentAdded {
+	/** The user that created the comment. */
+	readonly actor: Actor
+	/** The comment created. */
+	readonly comment: Comment
+	/** Id of the parent comment if one exists. */
+	readonly commentParentId: number
+	readonly date: string
+	readonly eventKey: "pr:comment:added"
+	/** The pull request comment on. */
+	readonly pullRequest: PullRequest
+}
+
+export interface Project {
+	readonly id: number
+	readonly key: string
+	readonly name: string
+	readonly public: boolean
+	readonly type: string
+}
+
+export interface Properties {
+	readonly repositoryId: number
+}
+
+export interface PullRequest {
+	readonly author: Author
+	readonly closed: boolean
+	readonly createdDate: number
+	readonly draft: boolean
+	readonly fromRef: Ref
+	readonly id: number
+	readonly locked: boolean
+	readonly open: boolean
+	readonly participants: unknown[]
+	readonly reviewers: unknown[]
+	readonly state: string
+	readonly title: string
+	readonly toRef: Ref
+	readonly updatedDate: number
+	readonly version: number
+}
+
+export interface Ref {
+	readonly displayId: string
+	readonly id: string
+	readonly latestCommit: string
+	readonly repository: Repository
+}
+
+export interface Repository {
+	readonly forkable: boolean
+	readonly id: number
+	readonly name: string
+	readonly project: Project
+	readonly public: boolean
+	readonly scmId: string
+	readonly slug: string
+	readonly state: string
+	readonly statusMessage: string
+}

src/server/webhooks/events/pr/comment_deleted.ts

@@ -0,0 +1,87 @@
+export interface Actor {
+	readonly active: boolean
+	readonly displayName: string
+	readonly emailAddress: string
+	readonly id: number
+	readonly name: string
+	readonly slug: string
+	readonly type: string
+}
+
+export interface Author {
+	readonly approved: boolean
+	readonly role: string
+	readonly status: string
+	readonly user: Actor
+}
+
+export interface Comment {
+	readonly author: Actor
+	readonly comments: unknown[]
+	readonly createdDate: number
+	readonly id: number
+	readonly tasks: unknown[]
+	readonly text: string
+	readonly updatedDate: number
+	readonly version: number
+}
+
+/** A user deletes a comment on a pull request. This payload comes with an event
+ * key of `pr:comment:deleted`. */
+export interface PRCommentDeleted {
+	/** The user that deleted the comment. */
+	readonly actor: Actor
+	/** The comment deleted. */
+	readonly comment: Comment
+	/** Id of the parent comment if one exists. */
+	readonly commentParentId: number
+	readonly date: string
+	readonly eventKey: "pr:comment:deleted"
+	/** The pull request where the comment existed. */
+	readonly pullRequest: PullRequest
+}
+
+export interface Project {
+	readonly id: number
+	readonly key: string
+	readonly name: string
+	readonly public: boolean
+	readonly type: string
+}
+
+export interface PullRequest {
+	readonly author: Author
+	readonly closed: boolean
+	readonly createdDate: number
+	readonly draft: boolean
+	readonly fromRef: Ref
+	readonly id: number
+	readonly locked: boolean
+	readonly open: boolean
+	readonly participants: unknown[]
+	readonly reviewers: unknown[]
+	readonly state: string
+	readonly title: string
+	readonly toRef: Ref
+	readonly updatedDate: number
+	readonly version: number
+}
+
+export interface Ref {
+	readonly displayId: string
+	readonly id: string
+	readonly latestCommit: string
+	readonly repository: Repository
+}
+
+export interface Repository {
+	readonly forkable: boolean
+	readonly id: number
+	readonly name: string
+	readonly project: Project
+	readonly public: boolean
+	readonly scmId: string
+	readonly slug: string
+	readonly state: string
+	readonly statusMessage: string
+}

src/server/webhooks/events/pr/comment_edited.ts

@@ -0,0 +1,93 @@
+export interface Actor {
+	readonly active: boolean
+	readonly displayName: string
+	readonly emailAddress: string
+	readonly id: number
+	readonly name: string
+	readonly slug: string
+	readonly type: string
+}
+
+export interface Author {
+	readonly approved: boolean
+	readonly role: string
+	readonly status: string
+	readonly user: Actor
+}
+
+export interface Comment {
+	readonly author: Actor
+	readonly comments: unknown[]
+	readonly createdDate: number
+	readonly id: number
+	readonly properties: Properties
+	readonly tasks: unknown[]
+	readonly text: string
+	readonly updatedDate: number
+	readonly version: number
+}
+
+/** This payload comes with an event key of `pr:comment:edited`. */
+export interface PRCommentEdited {
+	/** The user that edited the comment. */
+	readonly actor: Actor
+	/** The comment edited. */
+	readonly comment: Comment
+	/** Id of the parent comment if one exists. */
+	readonly commentParentId: number
+	readonly date: string
+	readonly eventKey: "pr:comment:edited"
+	/** Text of the previous comment. */
+	readonly previousComment: string
+	/** The pull request where the comment exists. */
+	readonly pullRequest: PullRequest
+}
+
+export interface Project {
+	readonly id: number
+	readonly key: string
+	readonly name: string
+	readonly public: boolean
+	readonly type: string
+}
+
+export interface Properties {
+	readonly repositoryId: number
+}
+
+export interface PullRequest {
+	readonly author: Author
+	readonly closed: boolean
+	readonly createdDate: number
+	readonly draft: boolean
+	readonly fromRef: Ref
+	readonly id: number
+	readonly locked: boolean
+	readonly open: boolean
+	readonly participants: unknown[]
+	readonly reviewers: unknown[]
+	readonly state: string
+	readonly title: string
+	readonly toRef: Ref
+	readonly updatedDate: number
+	readonly version: number
+}
+
+export interface Ref {
+	readonly displayId: string
+	readonly id: string
+	readonly latestCommit: string
+	readonly repository: Repository
+}
+
+export interface Repository {
+	readonly forkable: boolean
+	readonly id: number
+	readonly name: string
+	readonly project: Project
+	readonly public: boolean
+	readonly scmId: string
+	readonly slug: string
+	readonly state: string
+	readonly statusMessage: string
+}

src/server/webhooks/events/pr/declined.ts

@@ -0,0 +1,73 @@
+export interface Actor {
+	readonly active: boolean
+	readonly displayName: string
+	readonly emailAddress: string
+	readonly id: number
+	readonly name: string
+	readonly slug: string
+	readonly type: string
+}
+
+export interface Author {
+	readonly approved: boolean
+	readonly role: string
+	readonly status: string
+	readonly user: Actor
+}
+
+/** A user declines a pull request for a repository. This payload comes with an
+ * event key of `pr:declined`. */
+export interface PRDeclined {
+	/** The user who declined the pull request. */
+	readonly actor: Actor
+	readonly date: string
+	readonly eventKey: "pr:declined"
+	/** Details of the pull request declined. */
+	readonly pullRequest: PullRequest
+}
+
+export interface Project {
+	readonly id: number
+	readonly key: string
+	readonly name: string
+	readonly public: boolean
+	readonly type: string
+}
+
+export interface PullRequest {
+	readonly author: Author
+	readonly closed: boolean
+	readonly closedDate: number
+	readonly createdDate: number
+	readonly draft: boolean
+	readonly fromRef: Ref
+	readonly id: number
+	readonly locked: boolean
+	readonly open: boolean
+	readonly participants: unknown[]
+	readonly reviewers: Author[]
+	readonly state: string
+	readonly title: string
+	readonly toRef: Ref
+	readonly updatedDate: number
+	readonly version: number
+}
+
+export interface Ref {
+	readonly displayId: string
+	readonly id: string
+	readonly latestCommit: string
+	readonly repository: Repository
+}
+
+export interface Repository {
+	readonly forkable: boolean
+	readonly id: number
+	readonly name: string
+	readonly project: Project
+	readonly public: boolean
+	readonly scmId: string
+	readonly slug: string
+	readonly state: string
+	readonly statusMessage: string
+}