Refactor documentation in buttons-init.js, buttons-injection.js, and buttons.js for clarity and completeness

Author: MaxITService

buttons-init.js

@@ -1,17 +1,36 @@
+// buttons-init.js
 // Version: 1.0
 //
 // Documentation:
-// This file handles the initialization of custom buttons and toggles within the ChatGPT extension.
-// It ensures that custom buttons and toggles are created and appended to the DOM without duplication.
+// Initialization and rendering of the *entire* buttons row for target containers (inline chat area
+// or the floating panel). Prevents duplicates, composes all button types, and appends global toggles.
+//
+// What this module renders (in order):
+//  1) Floating panel toggle (for inline containers only, if the panel feature exists)
+//  2) Inline Profile Selector — optional, position configurable ("before" or "after")
+//  3) A unified list of buttons:
+//     - Cross-Chat buttons ("Copy", "Paste") placed "before" or "after" based on globalCrossChatConfig
+//     - Custom buttons from globalMaxExtensionConfig.customButtons (honors separators)
+//     - Numeric shortcuts (1–10) assigned to the first 10 non-separator buttons when enabled
+//  4) Global toggles appended last: "Auto-send" and "Hotkeys"
 //
 // Functions:
-// - createAndInsertCustomElements: Creates and inserts custom buttons and toggles into the target container.
-// - generateAndAppendToggles: Creates and appends toggle switches (e.g., Auto-send, Hotkeys) to a specified container.
-// - updateButtonsForProfileChange: Updates all buttons and toggles in response to a profile change.
+// - createAndInsertCustomElements(targetContainer): Creates the container, renders everything once, and inserts it.
+//   Uses a dynamic id from InjectionTargetsOnWebsite to avoid duplication.
+// - generateAndAppendAllButtons(container, isPanel): Main renderer for all buttons + optional controls.
+// - generateAndAppendToggles(container): Appends Auto-send and Hotkeys toggles and wires them to global config.
+// - updateButtonsForProfileChange(origin): Scoped re-render — only "panel" or only "inline".
+// - createInlineProfileSelector(): Builds the inline profile <select>, loads profile list, styles for theme,
+//   blocks event bubbling on hostile SPAs, and triggers a partial refresh on change.
+//
+// Notes:
+// - Cross-Chat placement and autosend behavior is driven by window.globalCrossChatConfig.
+// - Shortcut keys appear in tooltips; Shift+click inversion happens in processCustomSendButtonClick.
 //
 // Usage:
-// Ensure that `buttons.js` and `init.js` are loaded before this script to utilize button initialization functionalities.
-// This script should be included in the `content_scripts` section of the manifest to be injected into the target pages.
+// Ensure `buttons.js`, `utils.js`, and `init.js` are loaded first. Include in `content_scripts` so it runs
+// on the target pages. This module only performs DOM composition; click routing is in buttons.js.
+//
 // Instructions for AI: do not remove comments! MUST NOT REMOVE COMMENTS. This one too!
 'use strict';
 

buttons-injection.js

@@ -1,9 +1,9 @@
-'use strict';
-// button-injection.js version 1.1
+"use strict";
+// buttons-injection.js version 1.1
 /**
- * Button Injection Logic for the ChatGPT Chrome extension.
- * This file contains functions to handle custom button injection into the webpage,
- * including resiliency checks and re-initialization measures.
+ * Button Injection:
+ * Detects target containers, injects the buttons UI once, and maintains it across SPA navigation
+ * via adaptive resiliency checks and long-running DOM observation.
  */
 //Instructions for AI: do not remove comments!  MUST NOT REMOVE COMMENTS. This one too!
 // ALL CODE IN ALL FILES MUST USE logConCgp FOR LOGGING. NO CONSOLE LOGGING.
@@ -15,6 +15,17 @@ const EXTENDED_CHECK_DURATION = 2 * 60 * 60 * 1000; // 2 hours in milliseconds
 // Flag to coordinate with the floating panel toggle logic.
 window.OneClickPrompts_isTogglingPanel = false;
 
+/**
+ * Summary of behavior:
+ * - Loads persisted toggle states before any DOM work (MaxExtensionInterface.loadToggleStates()).
+ * - Waits for any of the configured target containers (InjectionTargetsOnWebsite.selectors.containers).
+ * - On first hit, calls MaxExtensionButtonsInit.createAndInsertCustomElements(targetDiv).
+ * - Starts an adaptive watchdog loop that re-injects when the UI disappears (e.g., SPA route changes).
+ * - Starts a MutationObserver for extended monitoring (up to 2 hours) to cheaply detect DOM wipes.
+ * - Coordinates with floating panel toggling via window.OneClickPrompts_isTogglingPanel to avoid races.
+ * - Stops event propagation on the inline profile <select> to prevent site handlers from closing it.
+ */
+
 /**
  * Checks whether the custom buttons modifications already exist in the DOM.
  * This is strengthened to check for child elements, not just the container.

buttons.js

@@ -1,25 +1,40 @@
 /* buttons.js
-   Version: 1.0
-
-   Documentation:
-
-   This file is a dependency. Designed to host helper functions for init.js. Manages the creation and functionality of custom send buttons within the ChatGPT extension.
-   It provides utility functions to create buttons based on configuration and assigns keyboard shortcuts where applicable.
-
-   After that, tje
-
-   Usage:
-   Ensure that dependencies are loaded before this script to utilize button functionalities.
-
-   Depends on:
-   utils.js - object containing all selectors and identifiers
-   buttons-init.js - handles only some initializations.
-   +
-   buttons-clicking-chatgpt.js - handles the send button clicking process for ChatGPT
-   buttons-clicking-copilot.js - ... for Copilot
-   buttons-clicking-claude.js - ... Claude
-
-   Instructions for AI: do not remove comments! MUST NOT REMOVE COMMENTS. This one too!
+     Version: 1.0
+
+     Documentation:
+     Button creation + click orchestration.
+     - Builds both custom send buttons (from profile/global config) and Cross-Chat buttons ("Copy", "Paste").
+     - Assigns numeric shortcuts (1–10) to the first 10 non-separator buttons (configurable via globalMaxExtensionConfig.enableShortcuts).
+     - Composes titles that include autosend status and shortcut hints.
+     - Handles click behavior across supported sites and integrates with queue mode in the floating panel.
+
+     Exposed methods:
+     - MaxExtensionButtons.createCustomSendButton(buttonConfig, index, onClickHandler, overrideShortcutKey?)
+     - MaxExtensionButtons.createCrossChatButton(type: 'copy'|'paste', shortcutKey?)
+     - MaxExtensionButtons.determineShortcutKeyForButtonIndex(buttonIndex, offset?)
+
+     Click flow:
+     - processCustomSendButtonClick(event, customText, autoSend)
+         * Shift inverts autoSend at click time.
+         * If the floating panel is visible and queue mode is enabled, the button is enqueued instead of sending immediately.
+         * Routes to site-specific handlers based on InjectionTargetsOnWebsite.activeSite:
+             - ChatGPT, Claude, Copilot, DeepSeek, AIStudio, Grok, Gemini
+
+     Cross-Chat notes:
+     - "Copy": reads from the active editor, saves via service worker, briefly shows "Copied!" in tooltip,
+         and triggers autosend with the existing text when configured.
+     - "Paste": fetches stored prompt; tooltip shows a debounced preview on hover.
+
+     Usage:
+     Load order should ensure `utils.js` and any site-specific clicking modules are present before use.
+     Rendering order and placement are orchestrated by buttons-init.js; this file focuses on element creation and behavior.
+
+     Depends on:
+     - utils.js (selectors and shared utilities)
+     - buttons-init.js (composition/placement)
+     - buttons-clicking-*.js (site handlers: chatgpt/claude/copilot/deepseek/aistudio/grok/gemini)
+
+     Instructions for AI: do not remove comments! MUST NOT REMOVE COMMENTS. This one too!
 */
 'use strict';