Allow extensions to specify minimum ST client version (#4350) * allow extensions to specify minimum client version * using existing version compare function * Move versionCompare to utils module --------- Co-authored-by: qvink <qvink@users.noreply.github.com> Co-authored-by: Cohee <18619528+Cohee1207@users.noreply.github.com>

5865a1a85b0fa51230e50e6cb49cab61c8458e7d

qvink <191186569+qvink@users.noreply.github.com>

Signed

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

 import { DOMPurify, Popper } from '../lib.js';
-import { eventSource, event_types, saveSettings, saveSettingsDebounced, getRequestHeaders, animation_duration } from '../script.js';
+import { eventSource, event_types, saveSettings, saveSettingsDebounced, getRequestHeaders, animation_duration, CLIENT_VERSION } from '../script.js';
 import { showLoader } from './loader.js';
 import { POPUP_RESULT, POPUP_TYPE, Popup, callGenericPopup } from './popup.js';
 import { renderTemplate, renderTemplateAsync } from './templates.js';
-import { delay, isSubsetOf, sanitizeSelector, setValueByPath } from './utils.js';
+import { delay, isSubsetOf, sanitizeSelector, setValueByPath, versionCompare } from './utils.js';
 import { getContext } from './st-context.js';
 import { isAdmin } from './user.js';
 import { addLocaleData, getCurrentLocale, t } from './i18n.js';

  */
 async function activateExtensions() {
     extensionLoadErrors.clear();
+    const clientVersion = CLIENT_VERSION.split(':')[1];
     const extensions = Object.entries(manifests).sort((a, b) => sortManifestsByOrder(a[1], b[1]));
     const extensionNames = extensions.map(x => x[0]);
     const promises = [];

         const manifest = entry[1];
         const extrasRequirements = manifest.requires;
         const extensionDependencies = manifest.dependencies;
+        const minClientVersion = manifest.minimum_client_version;
         const displayName = manifest.display_name || name;
         if (activeExtensions.has(name)) {
             continue;
+        }
+        // Client version requirement: pass if 'minimum_client_version' is undefined or null.
+        let meetsClientMinimumVersion = true;
+        if (minClientVersion !== undefined) {
+            meetsClientMinimumVersion = versionCompare(clientVersion, minClientVersion);
+        }
         // Module requirements: pass if 'requires' is undefined, null, or not an array; check subset if it's an array
         let meetsModuleRequirements = true;

         const isDisabled = extension_settings.disabledExtensions.includes(name);
-        if (meetsModuleRequirements && meetsExtensionDeps && !isDisabled) {
+        if (meetsModuleRequirements && meetsExtensionDeps && meetsClientMinimumVersion && !isDisabled) {
             try {
                 console.debug('Activating extension', name);
                 const promise = addExtensionLocale(name, manifest).finally(() =>

@@ -465,6 +472,9 @@ async function activateExtensions() {
465	console.warn(t`Extension "${name}" did not load. Missing required extensions: "${missingDependencies.join(', ')}"`);	472	console.warn(t`Extension "${name}" did not load. Missing required extensions: "${missingDependencies.join(', ')}"`);
466	extensionLoadErrors.add(t`Extension "${displayName}" did not load. Missing required extensions: "${missingDependencies.join(', ')}"`);	473	extensionLoadErrors.add(t`Extension "${displayName}" did not load. Missing required extensions: "${missingDependencies.join(', ')}"`);
467	}	474	}
		475	} else if (!meetsClientMinimumVersion && !isDisabled) {
		476	console.warn(t`Extension "${name}" did not load. Requires ST client version ${minClientVersion}, but current version is ${clientVersion}.`);
		477	extensionLoadErrors.add(t`Extension "${displayName}" did not load. Requires ST client version ${minClientVersion}, but current version is ${clientVersion}.`);
468	}	478	}
469	}	479	}
470		480

public/scripts/kai-settings.js+1 -11 Viewed

     power_user,
 } from './power-user.js';
 import { getEventSourceStream } from './sse-stream.js';
-import { getSortableDelay } from './utils.js';
+import { getSortableDelay, versionCompare } from './utils.js';
 export let koboldai_settings;
 export let koboldai_setting_names;

+}
 /**
- * Compares two version numbers, returning true if srcVersion >= minVersion
- * @param {string} srcVersion The current version.
- * @param {string} minVersion The target version number to test against
- * @returns {boolean} True if srcVersion >= minVersion, false if not
- */
-function versionCompare(srcVersion, minVersion) {
-    return (srcVersion || '0.0.0').localeCompare(minVersion, undefined, { numeric: true, sensitivity: 'base' }) > -1;
-}
-/**
  * Sorts the sampler items by the given order.
  * @param {any[]} orderArray Sampler order array.
  */

public/scripts/utils.js+10 -0 Viewed

     // If it doesn't contain the term, don't return anything
     return null;
+}
+/**
+ * Compares two version numbers, returning true if srcVersion >= minVersion
+ * @param {string} srcVersion The current version.
+ * @param {string} minVersion The target version number to test against
+ * @returns {boolean} True if srcVersion >= minVersion, false if not
+ */
+export function versionCompare(srcVersion, minVersion) {
+    return (srcVersion || '0.0.0').localeCompare(minVersion, undefined, { numeric: true, sensitivity: 'base' }) > -1;
+}