fix(tsdocs): re-enable proper apidocs generation

- added workaround to re-enable generation of packages which use `MixinTarget<Application>`
- fixed markdown hyperlinks inside HTML tables

see: gettalong/kramdown#822
fixes: #10205
Signed-off-by: Rifa Achrinza <[email protected]>

Author: achrinza

extensions/typeorm/src/typeorm.mixin.ts

@@ -15,6 +15,10 @@ import {
   LifeCycleObserver,
   MixinTarget,
 } from '@loopback/core';
+// `EventEmitter` required to allow tsdoc generation.
+// see: https://github.com/loopbackio/loopback-next/issues/10205
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import type {EventEmitter} from 'events';
 import debugFactory from 'debug';
 import {Connection, ConnectionManager, ConnectionOptions} from 'typeorm';
 import {TypeOrmConnectionBooter} from './';

package-lock.json

@@ -16,6 +16,10 @@ import {
   createBindingFromClass,
   MixinTarget,
 } from '@loopback/core';
+// `EventEmitter` required to allow tsdoc generation.
+// see: https://github.com/loopbackio/loopback-next/issues/10205
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import type {EventEmitter} from 'events';
 import {BootComponent} from '../boot.component';
 import {createComponentApplicationBooterBinding} from '../booters/component-application.booter';
 import {Bootstrapper} from '../bootstrapper';

packages/boot/src/mixins/boot.mixin.ts

@@ -10,6 +10,10 @@ import {
   Context,
   Provider,
 } from '@loopback/core';
+// `EventEmitter` required to allow tsdoc generation.
+// see: https://github.com/loopbackio/loopback-next/issues/10205
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import type {EventEmitter} from 'events';
 import {MiddlewareMixin} from './mixins/middleware.mixin';
 import {
   ExpressMiddlewareFactory,

packages/express/src/middleware-registry.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. and LoopBack contributors 2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 2020-2025. All Rights Reserved.
 // Node module: @loopback/express
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
@@ -12,6 +12,10 @@ import {
   MixinTarget,
   Provider,
 } from '@loopback/core';
+// `EventEmitter` required to allow tsdoc generation.
+// see: https://github.com/loopbackio/loopback-next/issues/10205
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import type {EventEmitter} from 'events';
 import {
   registerExpressMiddleware,
   registerMiddleware,

packages/express/src/mixins/middleware.mixin.ts

@@ -14,6 +14,10 @@ import {
   createBindingFromClass,
   MixinTarget,
 } from '@loopback/core';
+// `EventEmitter` required to allow tsdoc generation.
+// see: https://github.com/loopbackio/loopback-next/issues/10205
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import type {EventEmitter} from 'events';
 import debugFactory from 'debug';
 import {Class} from '../common-types';
 import {SchemaMigrationOptions} from '../datasource';

packages/repository/src/mixins/repository.mixin.ts

@@ -14,6 +14,10 @@ import {
   Provider,
   ServiceOptions,
 } from '@loopback/core';
+// `EventEmitter` required to allow tsdoc generation.
+// see: https://github.com/loopbackio/loopback-next/issues/10205
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import type {EventEmitter} from 'events';
 
 /**
  * Interface for classes with `new` operator.

packages/service-proxy/src/mixins/service.mixin.ts

@@ -67,17 +67,6 @@ export async function runExtractorForMonorepo(options: ExtractorOptions = {}) {
   const errors: Record<string, unknown> = {};
 
   for (const pkg of packages) {
-    // TODO: api-extractor failed to generate apidocs for the repos below.
-    // Excluding them for now
-    // https://github.com/loopbackio/loopback-next/issues/10205
-    if (
-      pkg.name === '@loopback/typeorm' ||
-      pkg.name === '@loopback/boot' ||
-      pkg.name === '@loopback/express' ||
-      pkg.name === '@loopback/repository' ||
-      pkg.name === '@loopback/service-proxy'
-    )
-      continue;
     /* istanbul ignore if  */
     const err = invokeExtractorForPackage(pkg, options);
     if (err != null) {

packages/tsdocs/src/monorepo-api-extractor.ts

@@ -85,6 +85,7 @@ async function addJekyllMetadata(
 
     const docFile = path.join(apiDocsRoot, f);
     let doc = await fs.readFile(docFile, 'utf-8');
+    doc = doc.replace(/<td>/g, '<td markdown="1">');
 
     const pkgName = name.split('.')[0];
     // Calculate the relative uri for the package