This commit broadens the search functionality within privacy.sexy by including documentation text in the search scope. Users can now find scripts and categories not only by their names but also by content in their documentation. This improvement aims to make the discovery of relevant scripts and information more intuitive and comprehensive. Key changes: - Documentation text is now searchable, enhancing the ability to discover scripts and categories based on content details. Other supporting changes: - Remove interface prefixes (`I`) from related interfaces to adhere to naming conventions, enhancing code readability. - Refactor filtering to separate actual filtering logic from filter state management, improving the structure for easier maintenance. - Improve test coverage to ensure relability of existing and new search capabilities. - Test coverage expanded to ensure the reliability of the new search capabilities.
91 lines
2.5 KiB
TypeScript
91 lines
2.5 KiB
TypeScript
import { BaseEntity } from '@/infrastructure/Entity/BaseEntity';
|
|
import { ICategory, IScript } from '@/domain/ICategory';
|
|
import { RecommendationLevel } from '@/domain/RecommendationLevel';
|
|
import { ScriptStub } from './ScriptStub';
|
|
|
|
export class CategoryStub extends BaseEntity<number> implements ICategory {
|
|
public name = `category-with-id-${this.id}`;
|
|
|
|
public readonly subCategories = new Array<ICategory>();
|
|
|
|
public readonly scripts = new Array<IScript>();
|
|
|
|
public docs: readonly string[] = new Array<string>();
|
|
|
|
private allScriptsRecursively: (readonly IScript[]) | undefined;
|
|
|
|
public constructor(id: number) {
|
|
super(id);
|
|
}
|
|
|
|
public includes(script: IScript): boolean {
|
|
return this.getAllScriptsRecursively().some((s) => s.id === script.id);
|
|
}
|
|
|
|
public getAllScriptsRecursively(): readonly IScript[] {
|
|
if (this.allScriptsRecursively === undefined) {
|
|
return [
|
|
...this.scripts,
|
|
...this.subCategories.flatMap((c) => c.getAllScriptsRecursively()),
|
|
];
|
|
}
|
|
return this.allScriptsRecursively;
|
|
}
|
|
|
|
public withScriptIds(...scriptIds: readonly string[]): this {
|
|
return this.withScripts(
|
|
...scriptIds.map((id) => new ScriptStub(id)),
|
|
);
|
|
}
|
|
|
|
public withScripts(...scripts: IScript[]): this {
|
|
for (const script of scripts) {
|
|
this.withScript(script);
|
|
}
|
|
return this;
|
|
}
|
|
|
|
public withAllScriptIdsRecursively(...scriptIds: readonly string[]): this {
|
|
return this.withAllScriptsRecursively(...scriptIds.map((id) => new ScriptStub(id)));
|
|
}
|
|
|
|
public withAllScriptsRecursively(...scripts: IScript[]): this {
|
|
this.allScriptsRecursively = [...scripts];
|
|
return this;
|
|
}
|
|
|
|
public withMandatoryScripts(): this {
|
|
return this
|
|
.withScript(new ScriptStub(`[${CategoryStub.name}] script-1`).withLevel(RecommendationLevel.Standard))
|
|
.withScript(new ScriptStub(`[${CategoryStub.name}] script-2`).withLevel(RecommendationLevel.Strict))
|
|
.withScript(new ScriptStub(`[${CategoryStub.name}] script-3`).withLevel(undefined));
|
|
}
|
|
|
|
public withCategories(...categories: ICategory[]): this {
|
|
for (const category of categories) {
|
|
this.withCategory(category);
|
|
}
|
|
return this;
|
|
}
|
|
|
|
public withCategory(category: ICategory): this {
|
|
this.subCategories.push(category);
|
|
return this;
|
|
}
|
|
|
|
public withScript(script: IScript): this {
|
|
this.scripts.push(script);
|
|
return this;
|
|
}
|
|
|
|
public withName(categoryName: string): this {
|
|
this.name = categoryName;
|
|
return this;
|
|
}
|
|
|
|
public withDocs(docs: readonly string[]): this {
|
|
this.docs = docs;
|
|
return this;
|
|
}
|
|
}
|