chore: fix issue with exported typeof should have been classes

Co-authored-by: Fredrik Adelöw <freben@users.noreply.github.com> Co-authored-by: Vincenzo Scamporlino <vinzscam@users.noreply.github.com> Co-authored-by: Camila Belo <camilaibs@users.noreply.github.com> Signed-off-by: blam <ben@blam.sh>
2024-06-19 12:12:00 +02:00
parent 29a0f56831
commit 100341c307
4 changed files with 202 additions and 42 deletions
@@ -88,27 +88,27 @@ export type AuthCallbackOptions = {
 // Warning: (ae-forgotten-export) The symbol "AwsS3UrlReader_2" needs to be exported by the entry point index.d.ts
 //
 // @public @deprecated (undocumented)
-export const AwsS3UrlReader: typeof AwsS3UrlReader_2;
+export class AwsS3UrlReader extends AwsS3UrlReader_2 {}

 // Warning: (ae-forgotten-export) The symbol "AzureUrlReader_2" needs to be exported by the entry point index.d.ts
 //
 // @public @deprecated (undocumented)
-export const AzureUrlReader: typeof AzureUrlReader_2;
+export class AzureUrlReader extends AzureUrlReader_2 {}

 // Warning: (ae-forgotten-export) The symbol "BitbucketCloudUrlReader_2" needs to be exported by the entry point index.d.ts
 //
 // @public @deprecated (undocumented)
-export const BitbucketCloudUrlReader: typeof BitbucketCloudUrlReader_2;
+export class BitbucketCloudUrlReader extends BitbucketCloudUrlReader_2 {}

 // Warning: (ae-forgotten-export) The symbol "BitbucketServerUrlReader_2" needs to be exported by the entry point index.d.ts
 //
 // @public @deprecated (undocumented)
-export const BitbucketServerUrlReader: typeof BitbucketServerUrlReader_2;
+export class BitbucketServerUrlReader extends BitbucketServerUrlReader_2 {}

 // Warning: (ae-forgotten-export) The symbol "BitbucketUrlReader_2" needs to be exported by the entry point index.d.ts
 //
 // @public @deprecated (undocumented)
-export const BitbucketUrlReader: typeof BitbucketUrlReader_2;
+export class BitbucketUrlReader extends BitbucketUrlReader_2 {}

 // @public @deprecated (undocumented)
 export type CacheClient = CacheService;
@@ -122,7 +122,7 @@ export type CacheClientSetOptions = CacheServiceSetOptions;
 // Warning: (ae-forgotten-export) The symbol "CacheManager_2" needs to be exported by the entry point index.d.ts
 //
 // @public @deprecated (undocumented)
-export const CacheManager: typeof CacheManager_2;
+export class CacheManager extends CacheManager_2 {}

 // Warning: (ae-forgotten-export) The symbol "CacheManagerOptions_2" needs to be exported by the entry point index.d.ts
 //
@@ -242,7 +242,7 @@ export type ErrorHandlerOptions = {
 // Warning: (ae-forgotten-export) The symbol "FetchUrlReader_2" needs to be exported by the entry point index.d.ts
 //
 // @public @deprecated (undocumented)
-export const FetchUrlReader: typeof FetchUrlReader_2;
+export class FetchUrlReader extends FetchUrlReader_2 {}

 // Warning: (ae-forgotten-export) The symbol "FromReadableArrayOptions_2" needs to be exported by the entry point index.d.ts
 //
@@ -252,7 +252,7 @@ export type FromReadableArrayOptions = FromReadableArrayOptions_2;
 // Warning: (ae-forgotten-export) The symbol "GerritUrlReader_2" needs to be exported by the entry point index.d.ts
 //
 // @public @deprecated (undocumented)
-export const GerritUrlReader: typeof GerritUrlReader_2;
+export class GerritUrlReader extends GerritUrlReader_2 {}

 // @public @deprecated
 export function getRootLogger(): winston.Logger;
@@ -339,27 +339,38 @@ export class Git {
 // Warning: (ae-forgotten-export) The symbol "GiteaUrlReader_2" needs to be exported by the entry point index.d.ts
 //
 // @public @deprecated (undocumented)
-export const GiteaUrlReader: typeof GiteaUrlReader_2;
+export class GiteaUrlReader extends GiteaUrlReader_2 {}

 // Warning: (ae-forgotten-export) The symbol "GithubUrlReader_2" needs to be exported by the entry point index.d.ts
 //
 // @public @deprecated (undocumented)
-export const GithubUrlReader: typeof GithubUrlReader_2;
+export class GithubUrlReader extends GithubUrlReader_2 {}

 // Warning: (ae-forgotten-export) The symbol "GitlabUrlReader_2" needs to be exported by the entry point index.d.ts
 //
 // @public @deprecated (undocumented)
-export const GitlabUrlReader: typeof GitlabUrlReader_2;
+export class GitlabUrlReader extends GitlabUrlReader_2 {}

 // Warning: (ae-forgotten-export) The symbol "HarnessUrlReader_2" needs to be exported by the entry point index.d.ts
 //
 // @public @deprecated (undocumented)
-export const HarnessUrlReader: typeof HarnessUrlReader_2;
+export class HarnessUrlReader extends HarnessUrlReader_2 {}

-// Warning: (ae-forgotten-export) The symbol "HostDiscovery_2" needs to be exported by the entry point index.d.ts
-//
 // @public @deprecated
-export const HostDiscovery: typeof HostDiscovery_2;
+class HostDiscovery implements DiscoveryService {
+  static fromConfig(
+    config: Config,
+    options?: {
+      basePath?: string;
+    },
+  ): HostDiscovery;
+  // (undocumented)
+  getBaseUrl(pluginId: string): Promise<string>;
+  // (undocumented)
+  getExternalBaseUrl(pluginId: string): Promise<string>;
+}
+export { HostDiscovery };
+export { HostDiscovery as SingleHostDiscovery };

 // @public @deprecated (undocumented)
 export const isChildPath: typeof isChildPath_2;
@@ -525,7 +536,7 @@ export type ReadUrlResponse = ReadUrlResponse_2;
 // Warning: (ae-forgotten-export) The symbol "ReadUrlResponseFactory_2" needs to be exported by the entry point index.d.ts
 //
 // @public @deprecated (undocumented)
-export const ReadUrlResponseFactory: typeof ReadUrlResponseFactory_2;
+export class ReadUrlResponseFactory extends ReadUrlResponseFactory_2 {}

 // Warning: (ae-forgotten-export) The symbol "ReadUrlResponseFactoryFromStreamOptions_2" needs to be exported by the entry point index.d.ts
 //
@@ -626,9 +637,6 @@ export type ServiceBuilder = {
 // @public @deprecated
 export function setRootLogger(newLogger: winston.Logger): void;

-// @public @deprecated
-export const SingleHostDiscovery: typeof HostDiscovery_2;
-
 // @public @deprecated
 export type StaticAuthOptions = {
  username?: string;
@@ -664,7 +672,7 @@ export type UrlReaderPredicateTuple = UrlReaderPredicateTuple_2;
 // Warning: (ae-forgotten-export) The symbol "UrlReaders_2" needs to be exported by the entry point index.d.ts
 //
 // @public @deprecated (undocumented)
-export const UrlReaders: typeof UrlReaders_2;
+export class UrlReaders extends UrlReaders_2 {}

 // Warning: (ae-forgotten-export) The symbol "UrlReadersOptions_2" needs to be exported by the entry point index.d.ts
 //
@@ -77,8 +77,6 @@ import type {

 import {
  DiscoveryService,
-  LifecycleService,
-  PluginMetadataService,
  CacheService,
  CacheServiceOptions,
  CacheServiceSetOptions,
@@ -97,6 +95,8 @@ import {
  SearchResponse as _SearchResponse,
  SearchResponseFile as _SearchResponseFile,
  UrlReaderService as _UrlReaderService,
+  LifecycleService,
+  PluginMetadataService,
 } from '@backstage/backend-plugin-api';

 export * from './hot';
@@ -125,7 +125,45 @@ export type PluginEndpointDiscovery = DiscoveryService;
 * @public
 * @deprecated Please import from `@backstage/backend-defaults/discovery` instead.
 */
-export const HostDiscovery = _HostDiscovery;
+export class HostDiscovery implements DiscoveryService {
+  /**
+   * Creates a new HostDiscovery discovery instance by reading
+   * from the `backend` config section, specifically the `.baseUrl` for
+   * discovering the external URL, and the `.listen` and `.https` config
+   * for the internal one.
+   *
+   * Can be overridden in config by providing a target and corresponding plugins in `discovery.endpoints`.
+   * eg.
+   * ```yaml
+   * discovery:
+   *  endpoints:
+   *    - target: https://internal.example.com/internal-catalog
+   *      plugins: [catalog]
+   *    - target: https://internal.example.com/secure/api/{{pluginId}}
+   *      plugins: [auth, permission]
+   *    - target:
+   *        internal: https://internal.example.com/search
+   *        external: https://example.com/search
+   *      plugins: [search]
+   * ```
+   *
+   * The basePath defaults to `/api`, meaning the default full internal
+   * path for the `catalog` plugin will be `http://localhost:7007/api/catalog`.
+   */
+  static fromConfig(config: Config, options?: { basePath?: string }) {
+    return new HostDiscovery(_HostDiscovery.fromConfig(config, options));
+  }
+
+  private constructor(private readonly impl: _HostDiscovery) {}
+
+  async getBaseUrl(pluginId: string): Promise<string> {
+    return this.impl.getBaseUrl(pluginId);
+  }
+
+  async getExternalBaseUrl(pluginId: string): Promise<string> {
+    return this.impl.getExternalBaseUrl(pluginId);
+  }
+}

 /**
 * SingleHostDiscovery is a basic PluginEndpointDiscovery implementation
@@ -138,13 +176,13 @@ export const HostDiscovery = _HostDiscovery;
 * @public
 * @deprecated Use `HostDiscovery` from `@backstage/backend-defaults/discovery` instead
 */
-export const SingleHostDiscovery = _HostDiscovery;
+export { HostDiscovery as SingleHostDiscovery };

 /**
 * @public
 * @deprecated Use `CacheManager` from the `@backstage/backend-defaults` package instead
 */
-export const CacheManager = _CacheManager;
+export class CacheManager extends _CacheManager {}

 /**
 * @public
@@ -257,79 +295,79 @@ export const isChildPath = _isChildPath;
 * @public
 * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
 */
-export const AzureUrlReader = _AzureUrlReader;
+export class AzureUrlReader extends _AzureUrlReader {}

 /**
 * @public
 * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
 */
-export const BitbucketCloudUrlReader = _BitbucketCloudUrlReader;
+export class BitbucketCloudUrlReader extends _BitbucketCloudUrlReader {}

 /**
 * @public
 * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
 */
-export const BitbucketUrlReader = _BitbucketUrlReader;
+export class BitbucketUrlReader extends _BitbucketUrlReader {}

 /**
 * @public
 * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
 */
-export const BitbucketServerUrlReader = _BitbucketServerUrlReader;
+export class BitbucketServerUrlReader extends _BitbucketServerUrlReader {}

 /**
 * @public
 * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
 */
-export const GerritUrlReader = _GerritUrlReader;
+export class GerritUrlReader extends _GerritUrlReader {}

 /**
 * @public
 * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
 */
-export const GithubUrlReader = _GithubUrlReader;
+export class GithubUrlReader extends _GithubUrlReader {}

 /**
 * @public
 * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
 */
-export const GitlabUrlReader = _GitlabUrlReader;
+export class GitlabUrlReader extends _GitlabUrlReader {}

 /**
 * @public
 * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
 */
-export const GiteaUrlReader = _GiteaUrlReader;
+export class GiteaUrlReader extends _GiteaUrlReader {}

 /**
 * @public
 * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
 */
-export const HarnessUrlReader = _HarnessUrlReader;
+export class HarnessUrlReader extends _HarnessUrlReader {}

 /**
 * @public
 * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
 */
-export const AwsS3UrlReader = _AwsS3UrlReader;
+export class AwsS3UrlReader extends _AwsS3UrlReader {}

 /**
 * @public
 * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
 */
-export const FetchUrlReader = _FetchUrlReader;
+export class FetchUrlReader extends _FetchUrlReader {}

 /**
 * @public
 * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
 */
-export const UrlReaders = _UrlReaders;
+export class UrlReaders extends _UrlReaders {}

 /**
 * @public
 * @deprecated Import from `@backstage/backend-defaults/urlReader` instead
 */
-export const ReadUrlResponseFactory = _ReadUrlResponseFactory;
+export class ReadUrlResponseFactory extends _ReadUrlResponseFactory {}

 /**
 * @public