Rename

Author: ntwigg

browser-extension/src/datamodel/enhancer.ts

@@ -0,0 +1,24 @@
+/**
+ * stores enough info about the location of a draft to:
+ * - display it in a table
+ * - reopen the draft in-context
+ */
+export interface CommentContext {
+  unique_key: string
+  type: string
+}
+
+/** wraps the textareas of a given platform with Gitcasso's enhancements */
+export interface CommentEnhancer<T extends CommentContext = CommentContext> {
+  /** guarantees to only return a type within this list */
+  forCommentTypes(): string[]
+  /**
+   * whenever a new `textarea` is added to any webpage, this method is called.
+   * if we return non-null, then we become the handler for that text area.
+   */
+  identifyContextOf(textarea: HTMLTextAreaElement): T | null
+
+  generateIcon(context: T): string
+  generateDisplayTitle(context: T): string
+  buildUrl(context: T, withDraft?: boolean): string
+}

browser-extension/src/datamodel/handler-registry.ts

@@ -1,4 +1,4 @@
-import type { CommentContext, TextareaHandler } from '../datamodel/textarea-handler'
+import type { CommentContext, CommentEnhancer } from '../enhancer'
 
 export type GitHubCommentType =
   | 'GH_ISSUE_NEW'
@@ -17,7 +17,7 @@ export interface GitHubContext extends CommentContext {
   commentId?: string | undefined // for editing existing comments
 }
 
-export class GitHubHandler implements TextareaHandler<GitHubContext> {
+export class GitHubHandler implements CommentEnhancer<GitHubContext> {
   forCommentTypes(): string[] {
     return [
       'GH_ISSUE_NEW',

…extension/src/handlers/github-handler.ts …src/datamodel/handlers/github-handler.tsbrowser-extension/src/handlers/github-handler.ts renamed to browser-extension/src/datamodel/handlers/github-handler.ts browser-extension/src/handlers/github-handler.ts renamed to browser-extension/src/datamodel/handlers/github-handler.ts

@@ -1,4 +1,4 @@
-import type { CommentContext, TextareaHandler } from '../datamodel/textarea-handler'
+import type { CommentContext, CommentEnhancer } from '../enhancer'
 
 export type RedditCommentType = 'REDDIT_POST_NEW' | 'REDDIT_COMMENT_NEW' | 'REDDIT_COMMENT_EDIT'
 
@@ -9,7 +9,7 @@ export interface RedditContext extends CommentContext {
   commentId?: string | undefined // for editing existing comments
 }
 
-export class RedditHandler implements TextareaHandler<RedditContext> {
+export class RedditHandler implements CommentEnhancer<RedditContext> {
   forCommentTypes(): string[] {
     return ['REDDIT_POST_NEW', 'REDDIT_COMMENT_NEW', 'REDDIT_COMMENT_EDIT']
   }

…extension/src/handlers/reddit-handler.ts …src/datamodel/handlers/reddit-handler.tsbrowser-extension/src/handlers/reddit-handler.ts renamed to browser-extension/src/datamodel/handlers/reddit-handler.ts browser-extension/src/handlers/reddit-handler.ts renamed to browser-extension/src/datamodel/handlers/reddit-handler.ts

@@ -0,0 +1,74 @@
+import type { CommentContext, CommentEnhancer } from './enhancer'
+import { GitHubHandler as GitHubEnhancer } from './handlers/github-handler'
+import { RedditHandler as RedditEnhancer } from './handlers/reddit-handler'
+
+export interface EnhancedTextarea<T extends CommentContext = CommentContext> {
+  element: HTMLTextAreaElement
+  context: T
+  handler: CommentEnhancer<T>
+}
+
+export class EnhancerRegistry {
+  private enhancers = new Set<CommentEnhancer<any>>()
+
+  constructor() {
+    // Register all available handlers
+    this.register(new GitHubEnhancer())
+    this.register(new RedditEnhancer())
+  }
+
+  private register<T extends CommentContext>(handler: CommentEnhancer<T>): void {
+    this.enhancers.add(handler)
+  }
+
+  getHandlerForType(type: string): CommentEnhancer<any> | null {
+    for (const handler of this.enhancers) {
+      if (handler.forCommentTypes().includes(type)) {
+        return handler
+      }
+    }
+    return null
+  }
+
+  identifyTextarea(textarea: HTMLTextAreaElement): EnhancedTextarea<any> | null {
+    for (const handler of this.enhancers) {
+      try {
+        const context = handler.identifyContextOf(textarea)
+        if (context) {
+          return { context, element: textarea, handler }
+        }
+      } catch (error) {
+        console.warn('Handler failed to identify textarea:', error)
+      }
+    }
+    return null
+  }
+
+  getAllHandlers(): CommentEnhancer<any>[] {
+    return Array.from(this.enhancers)
+  }
+
+  getCommentTypesForHandler(handler: CommentEnhancer<any>): string[] {
+    return handler.forCommentTypes()
+  }
+}
+
+export class TextareaRegistry {
+  private textareas = new Map<HTMLTextAreaElement, EnhancedTextarea<any>>()
+
+  register<T extends CommentContext>(textareaInfo: EnhancedTextarea<T>): void {
+    this.textareas.set(textareaInfo.element, textareaInfo)
+    // TODO: register as a draft in progress with the global list
+  }
+
+  unregisterDueToModification(textarea: HTMLTextAreaElement): void {
+    if (this.textareas.has(textarea)) {
+      // TODO: register as abandoned or maybe submitted with the global list
+      this.textareas.delete(textarea)
+    }
+  }
+
+  get(textarea: HTMLTextAreaElement): EnhancedTextarea<any> | undefined {
+    return this.textareas.get(textarea)
+  }
+}

browser-extension/src/datamodel/registries.ts

@@ -1,9 +1,8 @@
-import { HandlerRegistry } from '../datamodel/handler-registry'
-import { TextareaRegistry } from '../datamodel/textarea-registry'
+import { EnhancerRegistry, TextareaRegistry } from '../datamodel/registries'
 import { logger } from './content/logger'
 import { injectStyles } from './content/styles'
 
-const handlerRegistry = new HandlerRegistry()
+const handlerRegistry = new EnhancerRegistry()
 const textareaRegistry = new TextareaRegistry()
 
 export default defineContentScript({