Refactor unfurling related types (#6730)

* wip

* fix: refactor unfurl types

shared/types.ts

@@ -272,45 +272,97 @@ export const NotificationEventDefaults = {
   [NotificationEventType.AddUserToCollection]: true,
 };
 
-export enum UnfurlType {
+export enum UnfurlResourceType {
+  OEmbed = "oembed",
   Mention = "mention",
   Document = "document",
   Issue = "issue",
-  Pull = "pull",
+  PR = "pull",
 }
 
+export type UnfurlResponse = {
+  [UnfurlResourceType.OEmbed]: {
+    /** The resource type */
+    type: UnfurlResourceType.OEmbed;
+    /** URL pointing to the resource */
+    url: string;
+    /** A text title, describing the resource */
+    title: string;
+    /** A brief description about the resource */
+    description: string;
+    /** A URL to a thumbnail image representing the resource */
+    thumbnailUrl: string;
+  };
+  [UnfurlResourceType.Mention]: {
+    /** The resource type */
+    type: UnfurlResourceType.Mention;
+    /** Mentioned user's name */
+    name: string;
+    /** Mentioned user's avatar URL */
+    avatarUrl: string | null;
+    /** Used to create mentioned user's avatar if no avatar URL provided */
+    color: string;
+    /** Mentiond user's recent activity */
+    lastActive: string;
+  };
+  [UnfurlResourceType.Document]: {
+    /** The resource type */
+    type: UnfurlResourceType.Document;
+    /** URL pointing to the resource */
+    url: string;
+    /** Document id */
+    id: string;
+    /** Document title */
+    title: string;
+    /** Document summary */
+    summary: string;
+    /** Viewer's last activity on this document */
+    lastActivityByViewer: string;
+  };
+  [UnfurlResourceType.Issue]: {
+    /** The resource type */
+    type: UnfurlResourceType.Issue;
+    /** Issue link */
+    url: string;
+    /** Issue identifier */
+    id: string;
+    /** Issue title */
+    title: string;
+    /** Issue description */
+    description: string;
+    /** Issue's author */
+    author: { name: string; avatarUrl: string };
+    /** Issue's labels */
+    labels: Array<{ name: string; color: string }>;
+    /** Issue's status */
+    state: { name: string; color: string };
+    /** Issue's creation time */
+    createdAt: string;
+  };
+  [UnfurlResourceType.PR]: {
+    /** The resource type */
+    type: UnfurlResourceType.PR;
+    /** Pull Request link */
+    url: string;
+    /** Pull Request identifier */
+    id: string;
+    /** Pull Request title */
+    title: string;
+    /** Pull Request description */
+    description: string;
+    /** Pull Request author */
+    author: { name: string; avatarUrl: string };
+    /** Pull Request status */
+    state: { name: string; color: string };
+    /** Pull Request creation time */
+    createdAt: string;
+  };
+};
+
 export enum QueryNotices {
   UnsubscribeDocument = "unsubscribe-document",
 }
 
-export type OEmbedType = "photo" | "video" | "rich";
-
-export type UnfurlResponse<S = OEmbedType, T = Record<string, any>> = {
-  url?: string;
-  type: S | ("issue" | "pull" | "commit");
-  title: string;
-  description?: string;
-  createdAt?: string;
-  thumbnailUrl?: string | null;
-  author?: { name: string; avatarUrl: string };
-  meta?: T;
-};
-
-export type Unfurl =
-  | UnfurlResponse
-  | {
-      error: string;
-    };
-
-export type UnfurlSignature = (
-  url: string,
-  actor?: any
-) => Promise<Unfurl | void>;
-
-export type UninstallSignature = (
-  integration: Record<string, any>
-) => Promise<void>;
-
 export type JSONValue =
   | string
   | number