Add additional validation for boost options

Author: Gerrit0

src/lib/output/plugins/JavascriptIndexPlugin.ts

@@ -64,6 +64,7 @@ export class JavascriptIndexPlugin extends RendererComponent {
             }
 
             let parent = reflection.parent;
+            let boost = reflection.relevanceBoost ?? 1;
             if (parent instanceof ProjectReflection) {
                 parent = undefined;
             }
@@ -73,10 +74,9 @@ export class JavascriptIndexPlugin extends RendererComponent {
                     reflection.kind
                 );
 
-                const boost = kindBoosts[kinds[reflection.kind] ?? ""];
-                if (boost != undefined) {
-                    reflection.relevanceBoost =
-                        (reflection.relevanceBoost ?? 1) * boost;
+                const kindBoost = kindBoosts[kinds[reflection.kind] ?? ""];
+                if (kindBoost != undefined) {
+                    boost *= kindBoost;
                 }
             }
 
@@ -86,9 +86,12 @@ export class JavascriptIndexPlugin extends RendererComponent {
                 name: reflection.name,
                 url: reflection.url,
                 classes: reflection.cssClasses,
-                relevanceBoost: reflection.relevanceBoost,
             };
 
+            if (boost !== 1) {
+                row.boost = boost;
+            }
+
             if (parent) {
                 row.parent = parent.getFullName();
             }

src/lib/output/themes/default/assets/typedoc/components/Search.ts

@@ -8,7 +8,7 @@ interface IDocument {
     url: string;
     classes?: string;
     parent?: string;
-    relevanceBoost?: number;
+    boost?: number;
 }
 
 interface IData {
@@ -169,7 +169,7 @@ function updateResults(
         }
 
         // boost by relevanceBoost
-        boost *= row.relevanceBoost ?? 1;
+        boost *= row.boost ?? 1;
 
         item.score *= boost;
     }

src/lib/utils/options/sources/typedoc.ts

@@ -74,17 +74,36 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
         name: "searchCategoryBoosts",
         help: "Configure search to give a relevance boost to selected categories",
         type: ParameterType.Mixed,
+        validate(value) {
+            if (!isObject(value)) {
+                throw new Error(
+                    "The 'searchCategoryBoosts' option must be a non-array object."
+                );
+            }
+
+            if (Object.values(value).some((x) => typeof x !== "number")) {
+                throw new Error(
+                    "All values of 'searchCategoryBoosts' must be numbers."
+                );
+            }
+        },
     });
     options.addDeclaration({
         name: "searchGroupBoosts",
         help: 'Configure search to give a relevance boost to selected kinds (eg "class")',
         type: ParameterType.Mixed,
         validate(value: unknown) {
+            if (!isObject(value)) {
+                throw new Error(
+                    "The 'searchGroupBoosts' option must be a non-array object."
+                );
+            }
+
             const validValues = Object.values(ReflectionKind)
                 .filter((v) => typeof v === "string")
                 .map((v) => v.toString());
 
-            for (const kindName in value as { [key: string]: number }) {
+            for (const kindName in value) {
                 if (validValues.indexOf(kindName) < 0) {
                     throw new Error(
                         `'${kindName}' is an invalid value for 'searchGroupBoosts'. Must be one of: ${validValues.join(
@@ -93,6 +112,12 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
                     );
                 }
             }
+
+            if (Object.values(value).some((x) => typeof x !== "number")) {
+                throw new Error(
+                    "All values of 'searchGroupBoosts' must be numbers."
+                );
+            }
         },
     });
     options.addDeclaration({
@@ -341,11 +366,7 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
         help: "Specify the options passed to Marked, the Markdown parser used by TypeDoc.",
         type: ParameterType.Mixed,
         validate(value) {
-            if (
-                typeof value !== "object" ||
-                Array.isArray(value) ||
-                value == null
-            ) {
+            if (!isObject(value)) {
                 throw new Error(
                     "The 'markedOptions' option must be a non-array object."
                 );
@@ -357,11 +378,7 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
         help: "Selectively override the TypeScript compiler options used by TypeDoc.",
         type: ParameterType.Mixed,
         validate(value) {
-            if (
-                typeof value !== "object" ||
-                Array.isArray(value) ||
-                value == null
-            ) {
+            if (!isObject(value)) {
                 throw new Error(
                     "The 'compilerOptions' option must be a non-array object."
                 );
@@ -429,3 +446,7 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
         },
     });
 }
+
+function isObject(x: unknown): x is Record<string, unknown> {
+    return !!x && typeof x === "object" && !Array.isArray(x);
+}

src/test/utils/options/default-options.test.ts

@@ -76,4 +76,36 @@ describe("Default Options", () => {
             );
         });
     });
+
+    describe("searchCategoryBoosts", () => {
+        it("Should disallow non-objects", () => {
+            throws(() => opts.setValue("searchCategoryBoosts", null as never));
+        });
+
+        it("Should disallow non-numbers", () => {
+            throws(() =>
+                opts.setValue("searchCategoryBoosts", {
+                    cat: true,
+                })
+            );
+        });
+    });
+
+    describe("searchGroupBoosts", () => {
+        it("Should disallow non-objects", () => {
+            throws(() => opts.setValue("searchGroupBoosts", null as never));
+        });
+
+        it("Should disallow invalid kind names", () => {
+            throws(() => opts.setValue("searchGroupBoosts", { Enum2: 123 }));
+        });
+
+        it("Should disallow non-numbers", () => {
+            throws(() => opts.setValue("searchGroupBoosts", { Enum: true }));
+        });
+
+        it("Should allow groups", () => {
+            doesNotThrow(() => opts.setValue("searchGroupBoosts", { Enum: 5 }));
+        });
+    });
 });