@brunolemos/devhub-core 0.102.0 → 0.103.0

package/src/types/devhub.ts

@@ -77,6 +77,10 @@ export type IssueOrPullRequestPayloadEnhancement =
   | IssuePayloadEnhancement
   | PullRequestPayloadEnhancement
 
+export interface EventPayloadEnhancement extends BaseEnhancement {
+  enrichedPullRequest?: GitHubPullRequest
+}
+
 export interface EnhancedGitHubNotification
   extends Omit<GitHubNotification, 'reason'>,
     NotificationPayloadEnhancement {
@@ -95,7 +99,7 @@ export interface MultipleStarEvent
 }
 
 export type EnhancedGitHubEvent = (GitHubEvent | MultipleStarEvent) &
-  BaseEnhancement
+  EventPayloadEnhancement
 
 export type EnhancedGitHubIssue = GitHubIssue & IssuePayloadEnhancement
 
@@ -330,19 +334,17 @@ export type GenericColumnCreation<
   ColumnType extends
     | ActivityColumn
     | IssueOrPullRequestColumn
-    | NotificationColumn
+    | NotificationColumn,
 > = Omit<ColumnType, 'createdAt' | 'updatedAt'> & {
   createdAt?: string
   updatedAt?: string
 }
 
 export type ActivityColumnCreation = GenericColumnCreation<ActivityColumn>
-export type IssueOrPullRequestColumnCreation = GenericColumnCreation<
-  IssueOrPullRequestColumn
->
-export type NotificationColumnCreation = GenericColumnCreation<
-  NotificationColumn
->
+export type IssueOrPullRequestColumnCreation =
+  GenericColumnCreation<IssueOrPullRequestColumn>
+export type NotificationColumnCreation =
+  GenericColumnCreation<NotificationColumn>
 
 export type ColumnCreation =
   | ActivityColumnCreation
@@ -353,7 +355,7 @@ export type GenericColumnSubscriptionCreation<
   ColumnSubscriptionType extends
     | ActivityColumnSubscription
     | IssueOrPullRequestColumnSubscription
-    | NotificationColumnSubscription
+    | NotificationColumnSubscription,
 > = Omit<ColumnSubscriptionType, 'id' | 'data' | 'createdAt' | 'updatedAt'> & {
   id?: string | undefined
   data?: ColumnSubscriptionType['data'] | undefined
@@ -361,15 +363,12 @@ export type GenericColumnSubscriptionCreation<
   updatedAt?: string | undefined
 }
 
-export type ActivityColumnSubscriptionCreation = GenericColumnSubscriptionCreation<
-  ActivityColumnSubscription
->
-export type IssueOrPullRequestColumnSubscriptionCreation = GenericColumnSubscriptionCreation<
-  IssueOrPullRequestColumnSubscription
->
-export type NotificationColumnSubscriptionCreation = GenericColumnSubscriptionCreation<
-  NotificationColumnSubscription
->
+export type ActivityColumnSubscriptionCreation =
+  GenericColumnSubscriptionCreation<ActivityColumnSubscription>
+export type IssueOrPullRequestColumnSubscriptionCreation =
+  GenericColumnSubscriptionCreation<IssueOrPullRequestColumnSubscription>
+export type NotificationColumnSubscriptionCreation =
+  GenericColumnSubscriptionCreation<NotificationColumnSubscription>
 
 export type ColumnSubscriptionCreation =
   | ActivityColumnSubscriptionCreation
@@ -600,7 +599,7 @@ export interface Plan {
 export type UserPlan = GraphQLUserPlan
 
 export interface ItemPushNotification<
-  A extends { type: string; payload: any } = { type: string; payload: any }
+  A extends { type: string; payload: any } = { type: string; payload: any },
 > {
   title: string
   subtitle?: string

package/src/types/github.ts

@@ -259,6 +259,14 @@ export interface GitHubPullRequest {
   repository_url: string // https://api.github.com/repos/devhubapp/devhub
 }
 
+// The Events API returns an abbreviated pull_request with only a few
+// guaranteed fields. Everything else from GitHubPullRequest is optional.
+export type GitHubEventPullRequest = Pick<
+  GitHubPullRequest,
+  'id' | 'number' | 'head' | 'base' | 'url'
+> &
+  Partial<Omit<GitHubPullRequest, 'id' | 'number' | 'head' | 'base' | 'url'>>
+
 export interface GitHubRepo {
   id: number | string
   name: string
@@ -499,9 +507,10 @@ export interface GitHubPullRequestEvent {
       | 'opened'
       | 'edited'
       | 'closed'
+      | 'merged'
       | 'reopened'
     number: number
-    pull_request: GitHubPullRequest
+    pull_request: GitHubEventPullRequest
     sender: object
   }
   public?: boolean
@@ -518,7 +527,7 @@ export interface GitHubPullRequestReviewEvent {
   repo: GitHubRepo
   payload: {
     action: 'submitted'
-    pull_request: GitHubPullRequest
+    pull_request: GitHubEventPullRequest
     review: object
   }
   public?: boolean
@@ -538,7 +547,7 @@ export interface GitHubPullRequestReviewCommentEvent {
   payload: {
     action: 'created' | 'edited' | 'deleted'
     changes?: object
-    pull_request: GitHubPullRequest
+    pull_request: GitHubEventPullRequest
     comment: GitHubComment
   }
   public?: boolean
@@ -670,6 +679,10 @@ export type GitHubStateType = 'open' | 'closed' | 'merged'
 
 export type GitHubIssueOrPullRequest = GitHubIssue | GitHubPullRequest
 
+export type GitHubIssueOrPullRequestFromEvent =
+  | GitHubIssue
+  | GitHubEventPullRequest
+
 export type GitHubIssueOrPullRequestSubjectType = 'Issue' | 'PullRequest'
 
 export type GitHubItemSubjectType =

package/src/utils/constants.ts

@@ -29,11 +29,10 @@ export const DEFAULT_THEME_PAIR: ThemePair = {
 }
 
 export const DEFAULT_GITHUB_OAUTH_SCOPES = ['notifications', 'user:email']
-export const FULL_ACCESS_GITHUB_OAUTH_SCOPES = DEFAULT_GITHUB_OAUTH_SCOPES.includes(
-  'repo',
-)
-  ? DEFAULT_GITHUB_OAUTH_SCOPES
-  : [...DEFAULT_GITHUB_OAUTH_SCOPES, 'repo']
+export const FULL_ACCESS_GITHUB_OAUTH_SCOPES =
+  DEFAULT_GITHUB_OAUTH_SCOPES.includes('repo')
+    ? DEFAULT_GITHUB_OAUTH_SCOPES
+    : [...DEFAULT_GITHUB_OAUTH_SCOPES, 'repo']
 
 // unfortunately github permissions are still not granular enough.
 // code permission is required to support some events, e.g. commits