From d54455e5dbc8dd74c23dec5bf6f747a899b2eca7 Mon Sep 17 00:00:00 2001 From: Thomas Norling Date: Thu, 17 Oct 2024 16:31:10 -0700 Subject: [PATCH] apiExtractor --- lib/msal-common/apiReview/msal-common.api.md | 29 +------------------- lib/msal-common/src/client/BaseClient.ts | 8 +++--- 2 files changed, 5 insertions(+), 32 deletions(-) diff --git a/lib/msal-common/apiReview/msal-common.api.md b/lib/msal-common/apiReview/msal-common.api.md index 9acc6cd260..fb42de5629 100644 --- a/lib/msal-common/apiReview/msal-common.api.md +++ b/lib/msal-common/apiReview/msal-common.api.md @@ -637,9 +637,8 @@ export abstract class BaseClient { // (undocumented) protected networkClient: INetworkModule; // (undocumented) - protected networkManager: NetworkManager; - // (undocumented) protected performanceClient?: IPerformanceClient; + sendPostRequest(thumbprint: RequestThumbprint, tokenEndpoint: string, options: NetworkRequestOptions, correlationId: string): Promise>; // (undocumented) protected serverTelemetryManager: ServerTelemetryManager | null; // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen @@ -2704,17 +2703,6 @@ const nestedAppAuthBridgeDisabled = "nested_app_auth_bridge_disabled"; // @public (undocumented) const networkError = "network_error"; -// Warning: (ae-internal-missing-underscore) The name "NetworkManager" should be prefixed with an underscore because the declaration is marked as @internal -// -// @internal (undocumented) -export class NetworkManager { - constructor(networkClient: INetworkModule, cacheManager: CacheManager); - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - sendPostRequest(thumbprint: RequestThumbprint, tokenEndpoint: string, options: NetworkRequestOptions): Promise>; -} - // Warning: (ae-missing-release-tag) "NetworkRequestOptions" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public @@ -4119,21 +4107,6 @@ export class UrlString { validateAsUri(): void; } -// Warning: (ae-missing-release-tag) "UrlToHttpRequestOptions" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// -// @public (undocumented) -export type UrlToHttpRequestOptions = { - protocol: string; - hostname: string; - hash: string; - search: string; - pathname: string; - path: string; - href: string; - port?: number; - auth?: string; -}; - declare namespace UrlUtils { export { stripLeadingHashOrQuery, diff --git a/lib/msal-common/src/client/BaseClient.ts b/lib/msal-common/src/client/BaseClient.ts index 32472b4ae4..7e1a6a23e9 100644 --- a/lib/msal-common/src/client/BaseClient.ts +++ b/lib/msal-common/src/client/BaseClient.ts @@ -173,10 +173,10 @@ export abstract class BaseClient { /** * Wraps sendPostRequestAsync with necessary preflight and postflight logic - * @param thumbprint - * @param tokenEndpoint - * @param options - * @param correlationId + * @param thumbprint - Request thumbprint for throttling + * @param tokenEndpoint - Endpoint to make the POST to + * @param options - Body and Headers to include on the POST request + * @param correlationId - CorrelationId for telemetry */ async sendPostRequest( thumbprint: RequestThumbprint,