Add branch selection on extension installer Closes #3865

310b0f30cd5dce0a5d67a7666b42c1c231b34182

Cohee <18619528+Cohee1207@users.noreply.github.com>

Parents: 0ca4cc08bb8f429380fbee4eaa3a483b093e2cb8

public/scripts/RossAscends-mods.js+1 -1 Viewed

                     const result = await Popup.show.confirm('Regenerate Message', 'Are you sure you want to regenerate the latest message?', {
                         customInputs: [{ id: 'regenerateWithCtrlEnter', label: 'Don\'t ask again' }],
                         onClose: (popup) => {
-                            regenerateWithCtrlEnter = popup.inputResults.get('regenerateWithCtrlEnter') ?? false;
+                            regenerateWithCtrlEnter = Boolean(popup.inputResults.get('regenerateWithCtrlEnter') ?? false);
                         },
                     });
                     if (!result) {

public/scripts/extensions.js+13 -3 Viewed

  * @param {boolean} global Is the extension global?
  * @returns {Promise<void>}
  */
-export async function installExtension(url, global) {
+export async function installExtension(url, global, branch = '') {
     console.debug('Extension installation started', url);
     toastr.info(t`Please wait...`, t`Installing extension`);

         body: JSON.stringify({
             url,
             global,
+            branch,
         }),
     });

             await popup.complete(POPUP_RESULT.AFFIRMATIVE);
         },
     };
+    /** @type {import('./popup.js').CustomPopupInput} */
+    const branchNameInput = {
+        id: 'extension_branch_name',
+        label: t`Branch name (optional)`,
+        type: 'text',
+        tooltip: 'e.g. main, master, dev',
+    };
     const customButtons = isCurrentUserAdmin ? [installForAllButton] : [];
-    const popup = new Popup(html, POPUP_TYPE.INPUT, suggestUrl ?? '', { okButton, customButtons });
+    const customInputs = [branchNameInput];
+    const popup = new Popup(html, POPUP_TYPE.INPUT, suggestUrl ?? '', { okButton, customButtons, customInputs });
     const input = await popup.show();
     if (!input) {

@@ -1417,7 +1426,8 @@ export async function openThirdPartyExtensionMenu(suggestUrl = '') {
1417	}	1426	}
1418		1427
1419	const url = String(input).trim();	1428	const url = String(input).trim();
1420	await installExtension(url, global);	1429	const branchName = String(popup.inputResults.get('extension_branch_name') ?? '').trim();
		1430	await installExtension(url, global, branchName);
1421	}	1431	}
1422		1432
1423	export async function initExtensions() {	1433	export async function initExtensions() {

public/scripts/extensions/assets/index.js+2 -2 Viewed

     try {
         if (category === 'extension') {
             console.debug(DEBUG_PREFIX, 'Installing extension ', url);
-            await installExtension(url);
+            await installExtension(url, false);
             console.debug(DEBUG_PREFIX, 'Extension installed.');
             return;
+        }

@@ -309,7 +309,7 @@ async function installAsset(url, assetType, filename) {
309	console.debug(DEBUG_PREFIX, 'Importing character ', filename);	309	console.debug(DEBUG_PREFIX, 'Importing character ', filename);
310	const blob = await result.blob();	310	const blob = await result.blob();
311	const file = new File([blob], filename, { type: blob.type });	311	const file = new File([blob], filename, { type: blob.type });
312	await processDroppedFiles([file], true);	312	await processDroppedFiles([file]);
313	console.debug(DEBUG_PREFIX, 'Character downloaded.');	313	console.debug(DEBUG_PREFIX, 'Character downloaded.');
314	}	314	}
315	}	315	}

public/scripts/popup.js+31 -5 Viewed

  * @property {string} id - The id for the html element
  * @property {string} label - The label text for the input
  * @property {string?} [tooltip=null] - Optional tooltip icon displayed behind the label
- * @property {boolean?} [defaultState=false] - The default state when opening the popup (false if not set)
+ * @property {boolean|string|undefined} [defaultState=false] - The default state when opening the popup (false if not set)
+ * @property {string?} [type='checkbox'] - The type of the input (default is checkbox)
  */
 /**

     /** @type {POPUP_RESULT|number} */ result;
     /** @type {any} */ value;
-    /** @type {Map<string,boolean>?} */ inputResults;
+    /** @type {Map<string,string|boolean>?} */ inputResults;
     /** @type {any} */ cropData;
     /** @type {HTMLElement} */ lastFocus;

                 return;
+            }
+            if (!input.type || input.type === 'checkbox') {
                 const label = document.createElement('label');
                 label.classList.add('checkbox_label', 'justifyCenter');
                 label.setAttribute('for', input.id);
                 const inputElement = document.createElement('input');
                 inputElement.type = 'checkbox';
                 inputElement.id = input.id;
-            inputElement.checked = input.defaultState ?? false;
+                inputElement.checked = Boolean(input.defaultState ?? false);
                 label.appendChild(inputElement);
                 const labelText = document.createElement('span');
                 labelText.innerText = input.label;

+                }
                 this.inputControls.appendChild(label);
+            }
+            if (input.type === 'text') {
+                const label = document.createElement('label');
+                label.classList.add('text_label', 'justifyCenter');
+                label.setAttribute('for', input.id);
+                const inputElement = document.createElement('input');
+                inputElement.classList.add('text_pole');
+                inputElement.type = 'text';
+                inputElement.id = input.id;
+                inputElement.value = String(input.defaultState ?? '');
+                inputElement.placeholder = input.tooltip ?? '';
+                const labelText = document.createElement('span');
+                labelText.innerText = input.label;
+                labelText.dataset.i18n = input.label;
+                label.appendChild(labelText);
+                label.appendChild(inputElement);
+                this.inputControls.appendChild(label);
+            }
         });
         // Set the default button class

             this.inputResults = new Map(this.customInputs.map(input => {
                 /** @type {HTMLInputElement} */
                 const inputControl = this.dlg.querySelector(`#${input.id}`);
-                return [inputControl.id, inputControl.checked];
+                const value = input.type === 'text' ? inputControl.value : inputControl.checked;
+                return [inputControl.id, value];
             }));
+        }

         /** @readonly @type {Popup[]} Remember all popups */
         popups: [],
-        /** @type {{value: any, result: POPUP_RESULT|number?, inputResults: Map<string, boolean>?}?} Last popup result */
+        /** @type {{value: any, result: POPUP_RESULT|number?, inputResults: Map<string, string|boolean>?}?} Last popup result */
         lastResult: null,
         /** @returns {boolean} Checks if any modal popup dialog is open */

src/endpoints/extensions.js+7 -3 Viewed

             fs.mkdirSync(PUBLIC_DIRECTORIES.globalExtensions);
+        }
-        const { url, global } = request.body;
+        const { url, global, branch } = request.body;
         if (global && !request.user.profile.admin) {
             console.error(`User ${request.user.profile.handle} does not have permission to install global extensions.`);

             return response.status(409).send(`Directory already exists at ${extensionPath}`);
+        }
-        await git.clone(url, extensionPath, { '--depth': 1 });
+        const cloneOptions = { '--depth': 1 };
-        console.info(`Extension has been cloned at ${extensionPath}`);
+        if (branch) {
+            cloneOptions['--branch'] = branch;
+        }
+        await git.clone(url, extensionPath, cloneOptions);
+        console.info(`Extension has been cloned to ${extensionPath} from ${url} at ${branch || '(default)'} branch`);
         const { version, author, display_name } = await getManifest(extensionPath);