chore(deps): Update typedoc, typedoc theme and plugin (#15182)

dobromirts · web-flow · commit 65dd162030d2 · 2025-01-08T11:01:52.000+02:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -118,7 +118,7 @@
     "gulp-uglify": "^3.0.1",
     "hammer-simulator": "0.0.1",
     "hammerjs": "^2.0.8",
-    "ig-typedoc-theme": "^5.0.4",
+    "ig-typedoc-theme": "^6.0.0",
     "igniteui-dockmanager": "^1.15.2",
     "igniteui-sassdoc-theme": "^1.2.3",
     "igniteui-webcomponents": "5.1.2",
@@ -146,8 +146,8 @@
     "stylelint-prettier": "^5.0.2",
     "stylelint-scss": "^6.9.0",
     "ts-node": "^10.8.1",
-    "typedoc": "^0.26.11",
-    "typedoc-plugin-localization": "^3.0.5",
+    "typedoc": "^0.27.0",
+    "typedoc-plugin-localization": "^3.0.6",
     "typescript": "5.6.3"
   }
 }
diff --git a/projects/igniteui-angular/src/lib/accordion/accordion.component.ts b/projects/igniteui-angular/src/lib/accordion/accordion.component.ts
@@ -35,7 +35,7 @@ let NEXT_ID = 0;
  *
  * @igxGroup Layouts
  *
- * @remark
+ * @remarks
  * The Ignite UI for Angular Accordion component enables the user to navigate among multiple collapsing panels
  * displayed in a single container.
  * The accordion offers keyboard navigation and API to control the underlying panels' expansion state.
diff --git a/projects/igniteui-angular/src/lib/grids/columns/column.component.ts b/projects/igniteui-angular/src/lib/grids/columns/column.component.ts
@@ -650,7 +650,7 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
     /**
      * Applies display format to cell values in the column. Does not modify the underlying data.
      *
-     * @remark
+     * @remarks
      * Note: As the formatter is used in places like the Excel style filtering dialog, in certain
      * scenarios (remote filtering for example), the row data argument can be `undefined`.
      *
diff --git a/projects/igniteui-angular/src/lib/grids/grid-base.directive.ts b/projects/igniteui-angular/src/lib/grids/grid-base.directive.ts
@@ -4266,7 +4266,7 @@ export abstract class IgxGridBaseDirective implements GridType,
     /**
      * Gets/Sets the outlet used to attach the grid's overlays to.
      *
-     * @remark
+     * @remarks
      * If set, returns the outlet defined outside the grid. Otherwise returns the grid's internal outlet directive.
      */
     @Input()
diff --git a/projects/igniteui-angular/src/lib/grids/headers/grid-header-row.component.ts b/projects/igniteui-angular/src/lib/grids/headers/grid-header-row.component.ts
@@ -64,7 +64,7 @@ export class IgxGridHeaderRowComponent implements DoCheck {
     /**
      * Header groups inside the header row.
      *
-     * @remark
+     * @remarks
      * Note: These are only the top level header groups in case there are multi-column headers
      * or a specific column layout. If you want to get the flattened collection use the `groups`
      * property below.
diff --git a/projects/igniteui-angular/src/lib/grids/hierarchical-grid/hierarchical-grid-base.directive.ts b/projects/igniteui-angular/src/lib/grids/hierarchical-grid/hierarchical-grid-base.directive.ts
@@ -69,7 +69,7 @@ export abstract class IgxHierarchicalGridBaseDirective extends IgxGridBaseDirect
     /**
      * Gets/Sets whether the expand/collapse all button in the header should be rendered.
      *
-     * @remark
+     * @remarks
      * The default value is false.
      * @example
      * ```html
@@ -111,7 +111,7 @@ export abstract class IgxHierarchicalGridBaseDirective extends IgxGridBaseDirect
     /**
      * Gets the outlet used to attach the grid's overlays to.
      *
-     * @remark
+     * @remarks
      * If set, returns the outlet defined outside the grid. Otherwise returns the grid's internal outlet directive.
      */
     public override get outlet() {
diff --git a/projects/igniteui-angular/src/lib/list/list.component.ts b/projects/igniteui-angular/src/lib/list/list.component.ts
@@ -561,7 +561,7 @@ export class IgxListComponent extends IgxListBaseDirective {
     /**
      * Gets the `context` object of the template binding.
      *
-     * @remark
+     * @remarks
      * Gets the `context` object which represents the `template context` binding into the `list container`
      * by providing the `$implicit` declaration which is the `IgxListComponent` itself.
      *
diff --git a/projects/igniteui-angular/src/lib/tree/tree-node/tree-node.component.ts b/projects/igniteui-angular/src/lib/tree/tree-node/tree-node.component.ts
@@ -344,7 +344,7 @@ export class IgxTreeNodeComponent<T> extends ToggleAnimationPlayer implements Ig
     /**
      * Return the child nodes of the node (if any)
      *
-     * @remark
+     * @remarks
      * Returns `null` if node does not have children
      *
      * @example
diff --git a/projects/igniteui-angular/src/lib/tree/tree.component.ts b/projects/igniteui-angular/src/lib/tree/tree.component.ts
@@ -391,7 +391,7 @@ export class IgxTreeComponent implements IgxTree, OnInit, AfterViewInit, OnDestr
      * Returns all of the nodes that match the passed searchTerm.
      * Accepts a custom comparer function for evaluating the search term against the nodes.
      *
-     * @remark
+     * @remarks
      * Default search compares the passed `searchTerm` against the node's `data` Input.
      * When using `findNodes` w/o a `comparer`, make sure all nodes have `data` passed.
      *
diff --git a/scripts/build-typedoc.mjs b/scripts/build-typedoc.mjs
@@ -1,6 +1,6 @@
 import path from "path";
 import { fileURLToPath } from "url";
-import TypeDoc from "typedoc";
+import { Application } from "typedoc";
 import getArgs from "./get-args.mjs";
 
 const product = "ignite-ui-angular";
@@ -52,9 +52,9 @@ const CONFIG = {
     plugin: [
         path.resolve(
             __dirname,
-            "../node_modules/typedoc-plugin-localization/dist/",
+            "../node_modules/typedoc-plugin-localization/dist/index.js",
         ),
-        path.resolve(__dirname, "../node_modules/ig-typedoc-theme/dist/"),
+        path.resolve(__dirname, "../node_modules/ig-typedoc-theme/dist/index.js"),
     ],
     theme: "igtheme",
     excludePrivate: true,
@@ -66,7 +66,7 @@ const CONFIG = {
 };
 
 async function main() {
-    const app = await TypeDoc.Application.bootstrapWithPlugins(CONFIG);
+    const app = await Application.bootstrapWithPlugins(CONFIG);
 
     app.options.setValue("localize", localize ?? "en");
     app.options.setValue("product", product);

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ let NEXT_ID = 0;`
`35`	`35`	`*`
`36`	`36`	`* @igxGroup Layouts`
`37`	`37`	`*`
`38`		`- * @remark`
	`38`	`+ * @remarks`
`39`	`39`	`* The Ignite UI for Angular Accordion component enables the user to navigate among multiple collapsing panels`
`40`	`40`	`* displayed in a single container.`
`41`	`41`	`* The accordion offers keyboard navigation and API to control the underlying panels' expansion state.`
Original file line number	Diff line number	Diff line change
`@@ -650,7 +650,7 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy`
`650`	`650`	`/**`
`651`	`651`	`* Applies display format to cell values in the column. Does not modify the underlying data.`
`652`	`652`	`*`
`653`		`- * @remark`
	`653`	`+ * @remarks`
`654`	`654`	`* Note: As the formatter is used in places like the Excel style filtering dialog, in certain`
`655`	`655`	* scenarios (remote filtering for example), the row data argument can be `undefined`.
`656`	`656`	`*`
Original file line number	Diff line number	Diff line change
`@@ -4266,7 +4266,7 @@ export abstract class IgxGridBaseDirective implements GridType,`
`4266`	`4266`	`/**`
`4267`	`4267`	`* Gets/Sets the outlet used to attach the grid's overlays to.`
`4268`	`4268`	`*`
`4269`		`- * @remark`
	`4269`	`+ * @remarks`
`4270`	`4270`	`* If set, returns the outlet defined outside the grid. Otherwise returns the grid's internal outlet directive.`
`4271`	`4271`	`*/`
`4272`	`4272`	`@Input()`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ export class IgxGridHeaderRowComponent implements DoCheck {`
`64`	`64`	`/**`
`65`	`65`	`* Header groups inside the header row.`
`66`	`66`	`*`
`67`		`- * @remark`
	`67`	`+ * @remarks`
`68`	`68`	`* Note: These are only the top level header groups in case there are multi-column headers`
`69`	`69`	* or a specific column layout. If you want to get the flattened collection use the `groups`
`70`	`70`	`* property below.`
Original file line number	Diff line number	Diff line change
`@@ -561,7 +561,7 @@ export class IgxListComponent extends IgxListBaseDirective {`
`561`	`561`	`/**`
`562`	`562`	* Gets the `context` object of the template binding.
`563`	`563`	`*`
`564`		`- * @remark`
	`564`	`+ * @remarks`
`565`	`565`	* Gets the `context` object which represents the `template context` binding into the `list container`
`566`	`566`	* by providing the `$implicit` declaration which is the `IgxListComponent` itself.
`567`	`567`	`*`
Original file line number	Diff line number	Diff line change
`@@ -344,7 +344,7 @@ export class IgxTreeNodeComponent<T> extends ToggleAnimationPlayer implements Ig`
`344`	`344`	`/**`
`345`	`345`	`* Return the child nodes of the node (if any)`
`346`	`346`	`*`
`347`		`- * @remark`
	`347`	`+ * @remarks`
`348`	`348`	* Returns `null` if node does not have children
`349`	`349`	`*`
`350`	`350`	`* @example`
Original file line number	Diff line number	Diff line change
`@@ -391,7 +391,7 @@ export class IgxTreeComponent implements IgxTree, OnInit, AfterViewInit, OnDestr`
`391`	`391`	`* Returns all of the nodes that match the passed searchTerm.`
`392`	`392`	`* Accepts a custom comparer function for evaluating the search term against the nodes.`
`393`	`393`	`*`
`394`		`- * @remark`
	`394`	`+ * @remarks`
`395`	`395`	* Default search compares the passed `searchTerm` against the node's `data` Input.
`396`	`396`	* When using `findNodes` w/o a `comparer`, make sure all nodes have `data` passed.
`397`	`397`	`*`