[Platform-test]: Test Interactors documentation generation.

package.json

@@ -32,7 +32,9 @@
     "check": "npx biome check --formatter-enabled=true .",
     "check:fix": "npx biome check --formatter-enabled=true --write .",
     "prepare": "husky install",
-    "test_workflow": "act -W '.github/workflows/e2e-ci.yml' --action-offline-mode --container-architecture linux/amd64"
+    "test_workflow": "act -W '.github/workflows/e2e-ci.yml' --action-offline-mode --container-architecture linux/amd64",
+    "docs:test_interactors": "turbo run docs:test_interactors --filter=platform-test",
+    "docs:test_interactors:serve": "turbo run docs:test_interactors:serve --filter=platform-test"
   },
   "devDependencies": {
     "@biomejs/biome": "2.2.4",

packages/platform-test/.gitignore

@@ -0,0 +1,13 @@
+# Generated documentation
+docs/widgets-api/
+
+# Test results
+test-results/
+playwright-report/
+
+# Node
+node_modules/
+
+# Environment
+.env
+.env.local

packages/platform-test/POM/objects/widgets/AOTF/aotfActions.ts

@@ -1,5 +1,25 @@
 import type { Locator, Page } from "@playwright/test";
 
+/**
+ * Interactor for AOTF (Association On-The-Fly) table action controls.
+ *
+ * Provides methods to interact with the AOTF table's control panel including:
+ * - Name filtering
+ * - Advanced facets/filters
+ * - Column options and weight controls
+ * - Export functionality
+ * - Display mode switching (Associations/Prioritisation view)
+ *
+ * @example
+ * ```typescript
+ * const actions = new AotfActions(page);
+ * await actions.searchByName("BRAF");
+ * await actions.switchToPrioritisationView();
+ * await actions.openExportMenu();
+ * ```
+ *
+ * @category AOTF
+ */
 export class AotfActions {
   page: Page;
 

packages/platform-test/POM/objects/widgets/AOTF/aotfTable.ts

@@ -1,5 +1,23 @@
 import type { Locator, Page } from "@playwright/test";
 
+/**
+ * Interactor for the Association On-The-Fly (AOTF) Table component.
+ *
+ * The AOTF table displays target-disease associations with scores across
+ * different data types. It supports multiple sections (Pinned, Uploaded, Core)
+ * and provides functionality for sorting, filtering, and pagination.
+ *
+ * @example
+ * ```typescript
+ * const table = new AotfTable(page);
+ * await table.waitForTableLoad();
+ * const rowCount = await table.getRowCount();
+ * const entityName = await table.getEntityName(0);
+ * ```
+ *
+ * @category AOTF
+ * @remarks Section ID: `associations-table`
+ */
 export class AotfTable {
   page: Page;
 

packages/platform-test/POM/objects/widgets/Bibliography/bibliographySection.ts

@@ -1,5 +1,23 @@
 import type { Locator, Page } from "@playwright/test";
 
+/**
+ * Interactor for the Bibliography section widget.
+ *
+ * Displays literature references and publications related to a target, disease,
+ * or drug. Supports searching through literature, pagination, and external
+ * PubMed links.
+ *
+ * @example
+ * ```typescript
+ * const biblio = new BibliographySection(page);
+ * await biblio.waitForSectionLoad();
+ * const count = await biblio.getLiteratureCount();
+ * await biblio.searchLiterature("BRAF mutation");
+ * ```
+ *
+ * @category Bibliography
+ * @remarks Section ID: `bibliography`
+ */
 export class BibliographySection {
   page: Page;
 

packages/platform-test/POM/objects/widgets/CredibleSet/locus2GeneSection.ts

@@ -1,17 +1,39 @@
 import type { Locator, Page } from "@playwright/test";
 
 /**
- * Interactor for Locus-to-Gene (L2G) section on Credible Set page
- * Section ID: locus2gene
+ * Interactor for Locus-to-Gene (L2G) section on Credible Set page.
+ *
+ * The L2G section displays gene prioritization scores based on various
+ * evidence sources. Uses a HeatmapTable to visualize scores across
+ * different features.
+ *
+ * @example
+ * ```typescript
+ * const l2g = new Locus2GeneSection(page);
+ * await l2g.waitForLoad();
+ * const geneCount = await l2g.getTableRows();
+ * const topGene = await l2g.getTargetGeneName(0);
+ * const score = await l2g.getL2GScore(0);
+ * ```
+ *
+ * @category CredibleSet
+ * @remarks Section ID: `locus2gene`
  */
 export class Locus2GeneSection {
   constructor(private page: Page) {}
 
-  // Section container
+  /**
+   * Get the main section container element.
+   * @returns Locator for the section container
+   */
   getSection(): Locator {
     return this.page.locator("[data-testid='section-locus2gene']");
   }
 
+  /**
+   * Check if the section is currently visible on the page.
+   * @returns Promise resolving to true if visible, false otherwise
+   */
   async isSectionVisible(): Promise<boolean> {
     return await this.getSection()
       .isVisible()

packages/platform-test/POM/objects/widgets/KnownDrugs/knownDrugsSection.ts

@@ -1,5 +1,24 @@
 import type { Locator, Page } from "@playwright/test";
 
+/**
+ * Interactor for the Known Drugs / Clinical Precedence section.
+ *
+ * Displays drugs that have been used to treat a disease or target,
+ * including clinical trial information and approval status.
+ * Supports searching, filtering, and pagination.
+ *
+ * @example
+ * ```typescript
+ * const drugs = new ClinicalPrecedenceSection(page);
+ * await drugs.waitForSectionLoad();
+ * const rowCount = await drugs.getRowCount();
+ * const drugName = await drugs.getDrugName(0);
+ * await drugs.searchDrug("aspirin");
+ * ```
+ *
+ * @category KnownDrugs
+ * @remarks Section ID: `knowndrugs`
+ */
 export class ClinicalPrecedenceSection {
   page: Page;
 

packages/platform-test/POM/objects/widgets/Variant/variantEffectSection.ts

@@ -1,16 +1,39 @@
 import type { Locator, Page } from "@playwright/test";
 
 /**
- * Interactor for Variant Effect section
+ * Interactor for Variant Effect / In-Silico Predictors section.
+ *
+ * Displays computational predictions of variant effects from various
+ * in-silico prediction methods. Supports both table and chart views
+ * for visualizing prediction scores.
+ *
+ * @example
+ * ```typescript
+ * const variantEffect = new VariantEffectSection(page);
+ * await variantEffect.waitForLoad();
+ * const methodName = await variantEffect.getMethodName(0);
+ * const prediction = await variantEffect.getPrediction(0);
+ * await variantEffect.switchToChartView();
+ * ```
+ *
+ * @category Variant
+ * @remarks Section ID: `in-silico-predictors`
  */
 export class VariantEffectSection {
   constructor(private page: Page) {}
 
-  // Section container
+  /**
+   * Get the main section container element.
+   * @returns Locator for the section container
+   */
   getSection(): Locator {
     return this.page.locator("[data-testid='section-in-silico-predictors']");
   }
 
+  /**
+   * Check if the section is currently visible.
+   * @returns Promise resolving to true if visible, false otherwise
+   */
   async isSectionVisible(): Promise<boolean> {
     return await this.getSection()
       .isVisible()

packages/platform-test/POM/objects/widgets/shared/GWASCredibleSetsSection.ts

@@ -1,8 +1,35 @@
 import type { Locator, Page } from "@playwright/test";
 
 /**
- * Shared interactor for GWAS Credible Sets section
- * Used in both Variant and Study pages
+ * Interactor for the GWAS Credible Sets section (shared across Variant and Study pages).
+ *
+ * Displays fine-mapped credible sets from GWAS studies, representing the set of
+ * variants most likely to contain the causal variant. Information includes:
+ * - **Credible set ID**: Unique identifier linking to detailed credible set page
+ * - **Lead variant**: The most significant variant in the set
+ * - **Study information**: GWAS study ID and reported trait
+ * - **L2G gene**: Top gene from Locus-to-Gene prediction
+ * - **Posterior probability**: Statistical confidence for causal variants
+ *
+ * Used for both Variant pages (showing credible sets containing the variant)
+ * and Study pages (showing all credible sets from a study).
+ *
+ * @example
+ * ```typescript
+ * const gwasCredibleSets = new GWASCredibleSetsSection(page);
+ * await gwasCredibleSets.waitForLoad();
+ *
+ * // Get credible set details
+ * const rowCount = await gwasCredibleSets.getTableRows();
+ * const credibleSetId = await gwasCredibleSets.getCredibleSetId(0);
+ *
+ * // Navigate to related pages
+ * await gwasCredibleSets.clickCredibleSetLink(0);
+ * await gwasCredibleSets.clickStudyLink(0);
+ * ```
+ *
+ * @category shared
+ * @remarks Section ID: `gwas-credible-sets`
  */
 export class GWASCredibleSetsSection {
   constructor(private page: Page) {}

packages/platform-test/POM/objects/widgets/shared/adverseEventsSection.ts

@@ -1,7 +1,27 @@
 import type { Locator, Page } from "@playwright/test";
 
 /**
- * Interactor for Adverse Events section
+ * Interactor for the Adverse Events (Pharmacovigilance) section on Drug pages.
+ *
+ * Displays adverse event data from the FDA Adverse Event Reporting System (FAERS),
+ * including event names with MedDRA links, reported event counts, and log likelihood
+ * ratios indicating the strength of the drug-adverse event association.
+ *
+ * @example
+ * ```typescript
+ * const adverseEvents = new PharmacovigilanceSection(page);
+ * await adverseEvents.waitForLoad();
+ *
+ * // Get number of adverse events
+ * const rowCount = await adverseEvents.getTableRows();
+ *
+ * // Get details of first adverse event
+ * const eventName = await adverseEvents.getAdverseEventName(0);
+ * const llr = await adverseEvents.getLogLikelihoodRatio(0);
+ * ```
+ *
+ * @category shared
+ * @remarks Section ID: `adverseevents`
  */
 export class PharmacovigilanceSection {
   constructor(private page: Page) {}

packages/platform-test/POM/objects/widgets/shared/cancerHallmarksSection.ts

@@ -1,9 +1,32 @@
 import type { Locator, Page } from "@playwright/test";
 
 /**
- * Interactor for Cancer Hallmarks section on Target page
- * Displays cancer hallmarks with role in cancer chips and a table of hallmark effects
- * Uses only data-testid selectors for reliable, predictable testing
+ * Interactor for the Cancer Hallmarks section on Target pages.
+ *
+ * Displays cancer hallmark annotations based on the "Hallmarks of Cancer" framework,
+ * showing the target's role in cancer progression. The section includes:
+ * - **Role in Cancer chips**: Visual indicators of oncogene/tumor suppressor roles
+ * - **Hallmark effects table**: Detailed breakdown of hallmark impacts with literature evidence
+ *
+ * Data is sourced from manually curated literature with links to supporting publications.
+ *
+ * @example
+ * ```typescript
+ * const cancerHallmarks = new CancerHallmarksSection(page);
+ * await cancerHallmarks.waitForLoad();
+ *
+ * // Check role in cancer
+ * const roleLabel = await cancerHallmarks.getRoleInCancerChipLabel(0);
+ *
+ * // Search hallmarks table
+ * await cancerHallmarks.search("proliferation");
+ *
+ * // Access publications
+ * await cancerHallmarks.clickPublicationsDrawer();
+ * ```
+ *
+ * @category shared
+ * @remarks Section ID: `cancerhallmarks`
  */
 export class CancerHallmarksSection {
   constructor(private page: Page) {}

packages/platform-test/POM/objects/widgets/shared/chemicalProbesSection.ts

@@ -1,9 +1,35 @@
 import type { Locator, Page } from "@playwright/test";
 
 /**
- * Interactor for Chemical Probes section on Target page
- * Displays chemical probes with quality ratings and mechanisms of action
- * Uses only data-testid selectors for reliable, predictable testing
+ * Interactor for the Chemical Probes section on Target pages.
+ *
+ * Displays high-quality chemical probes that can be used to investigate
+ * target biology. Data is sourced from the Chemical Probes Portal and includes:
+ * - **Probe names**: Identifiers with links to external resources
+ * - **Quality ratings**: Probe quality assessments (e.g., "Best available", "Historical")
+ * - **Mechanisms of action**: How the probe interacts with the target
+ * - **Selectivity information**: Off-target effects and specificity data
+ *
+ * Chemical probes are small molecules designed to selectively modulate protein
+ * function for research purposes.
+ *
+ * @example
+ * ```typescript
+ * const chemicalProbes = new ChemicalProbesSection(page);
+ * await chemicalProbes.waitForLoad();
+ *
+ * // Check if probes are available
+ * const hasProbes = await chemicalProbes.isTableVisible();
+ *
+ * // Search for specific probe
+ * await chemicalProbes.search("JQ1");
+ *
+ * // Download probe data
+ * await chemicalProbes.clickDataDownloader();
+ * ```
+ *
+ * @category shared
+ * @remarks Section ID: `chemicalprobes`
  */
 export class ChemicalProbesSection {
   constructor(private page: Page) {}

packages/platform-test/POM/objects/widgets/shared/comparativeGenomicsSection.ts

@@ -1,9 +1,37 @@
 import type { Locator, Page } from "@playwright/test";
 
 /**
- * Interactor for Comparative Genomics section on Target page
- * Displays orthologues and paralogues with a chart and table view
- * Uses only data-testid selectors for reliable, predictable testing
+ * Interactor for the Comparative Genomics section on Target pages.
+ *
+ * Displays evolutionary conservation data showing homologous genes across species.
+ * Data is sourced from Ensembl Compara and includes:
+ * - **Orthologues**: Genes in other species that evolved from a common ancestor
+ * - **Paralogues**: Genes within the same species arising from gene duplication
+ * - **Homology types**: One-to-one, one-to-many, many-to-many relationships
+ * - **Sequence identity**: Percentage similarity between protein sequences
+ *
+ * The section supports two visualization modes:
+ * - **Chart view**: Phylogenetic tree visualization of homologues
+ * - **Table view**: Detailed tabular data with search and pagination
+ *
+ * @example
+ * ```typescript
+ * const compGenomics = new ComparativeGenomicsSection(page);
+ * await compGenomics.waitForLoad();
+ *
+ * // Switch between views
+ * await compGenomics.switchToChartView();
+ * const chartVisible = await compGenomics.isChartVisible();
+ *
+ * await compGenomics.switchToTableView();
+ * await compGenomics.search("mouse");
+ *
+ * // Download data
+ * await compGenomics.clickDataDownloader();
+ * ```
+ *
+ * @category shared
+ * @remarks Section ID: `compgenomics`
  */
 export class ComparativeGenomicsSection {
   constructor(private page: Page) {}