Fix typedoc deployment workflow (#6321)

Fixes typedoc deployment on PR merges. Typedocs have been updated
manually

.github/workflows/typedoc.yml

@@ -13,7 +13,7 @@ jobs:
     if: ((github.event.pull_request.merged == true && contains(github.head_ref,'post-release')) || github.event_name == 'workflow_dispatch')
     runs-on: ubuntu-latest
     permissions:
-      contents: read
+      contents: write
       pages: write
     steps:
       - uses: actions/checkout@v3
@@ -30,7 +30,7 @@ jobs:
         run: npm ci
 
       - name: Build
-        run: npm run build
+        run: npm run build --workspace=lib/** --workspace=extensions/**
 
       - name: Generate
         run: npm run doc:generate

change/@azure-msal-angular-b69b070a-d2c5-4330-8cf1-9d41ffbc9749.json

@@ -0,0 +1,7 @@
+{
+  "type": "none",
+  "comment": "Typedocs",
+  "packageName": "@azure/msal-angular",
+  "email": "[email protected]",
+  "dependentChangeType": "none"
+}

change/@azure-msal-browser-7a080449-1a09-4acf-b993-6370834eaec9.json

@@ -0,0 +1,7 @@
+{
+  "type": "none",
+  "comment": "Typedocs",
+  "packageName": "@azure/msal-browser",
+  "email": "[email protected]",
+  "dependentChangeType": "none"
+}

change/@azure-msal-common-88a3f3ff-51dd-4388-bb05-0988f32b4111.json

@@ -0,0 +1,7 @@
+{
+  "type": "none",
+  "comment": "Typedocs",
+  "packageName": "@azure/msal-common",
+  "email": "[email protected]",
+  "dependentChangeType": "none"
+}

change/@azure-msal-node-ad549be5-8392-4a30-bfc9-65b0c6dc9774.json

@@ -0,0 +1,7 @@
+{
+  "type": "none",
+  "comment": "Typedocs",
+  "packageName": "@azure/msal-node",
+  "email": "[email protected]",
+  "dependentChangeType": "none"
+}

change/@azure-msal-node-extensions-0de689eb-5e67-4678-b56d-474a62014a58.json

@@ -0,0 +1,7 @@
+{
+  "type": "none",
+  "comment": "Typedocs",
+  "packageName": "@azure/msal-node-extensions",
+  "email": "[email protected]",
+  "dependentChangeType": "none"
+}

change/@azure-msal-react-93fd73f1-607d-4b5b-b9e7-e45c5e504e7c.json

@@ -0,0 +1,7 @@
+{
+  "type": "none",
+  "comment": "Typedocs",
+  "packageName": "@azure/msal-react",
+  "email": "[email protected]",
+  "dependentChangeType": "none"
+}

extensions/msal-node-extensions/typedoc.json

@@ -0,0 +1,10 @@
+{
+    "extends": [
+        "../../typedoc.base.json"
+    ],
+    "entryPoints": [
+        "src/index.ts"
+    ],
+    "tsconfig": "tsconfig.build.json",
+    "readme": "./README.md"
+}

lib/msal-angular/typedoc.json

@@ -0,0 +1,10 @@
+{
+    "extends": [
+        "../../typedoc.base.json"
+    ],
+    "entryPoints": [
+        "src/public-api.ts"
+    ],
+    "tsconfig": "tsconfig.lib.prod.json",
+    "readme": "./README.md"
+}

lib/msal-browser/src/app/IPublicClientApplication.ts

@@ -56,6 +56,7 @@ export interface IPublicClientApplication {
     getActiveAccount(): AccountInfo | null;
     initializeWrapperLibrary(sku: WrapperSKU, version: string): void;
     setNavigationClient(navigationClient: INavigationClient): void;
+    /** @internal */
     getConfiguration(): BrowserConfiguration;
     hydrateCache(
         result: AuthenticationResult,

lib/msal-browser/src/app/PublicClientApplication.ts

@@ -112,7 +112,7 @@ export class PublicClientApplication implements IPublicClientApplication {
      * Silently acquire an access token for a given set of scopes. Returns currently processing promise if parallel requests are made.
      *
      * @param {@link (SilentRequest:type)}
-     * @returns {Promise.<AuthenticationResult>} - a promise that is fulfilled when this function has completed, or rejected if an error was raised. Returns the {@link AuthResponse} object
+     * @returns {Promise.<AuthenticationResult>} - a promise that is fulfilled when this function has completed, or rejected if an error was raised. Returns the {@link AuthenticationResult} object
      */
     acquireTokenSilent(
         silentRequest: SilentRequest
@@ -370,6 +370,7 @@ export class PublicClientApplication implements IPublicClientApplication {
 
     /**
      * Returns the configuration object
+     * @internal
      */
     getConfiguration(): BrowserConfiguration {
         return this.controller.getConfiguration();

lib/msal-browser/src/config/Configuration.ts

@@ -95,6 +95,7 @@ export type BrowserAuthOptions = {
     skipAuthorityMetadataCache?: boolean;
 };
 
+/** @internal */
 export type InternalAuthOptions = Required<BrowserAuthOptions> & {
     OIDCOptions: Required<OIDCOptions>;
 };
@@ -220,6 +221,7 @@ export type Configuration = {
     telemetry?: BrowserTelemetryOptions;
 };
 
+/** @internal */
 export type BrowserConfiguration = {
     auth: InternalAuthOptions;
     cache: Required<CacheOptions>;

lib/msal-browser/src/controllers/IController.ts

@@ -103,6 +103,7 @@ export interface IController {
 
     setNavigationClient(navigationClient: INavigationClient): void;
 
+    /** @internal */
     getConfiguration(): BrowserConfiguration;
 
     hydrateCache(
@@ -114,43 +115,58 @@ export interface IController {
             | PopupRequest
     ): Promise<void>;
 
+    /** @internal */
     isBrowserEnv(): boolean;
 
+    /** @internal */
     getBrowserStorage(): BrowserCacheManager;
 
+    /** @internal */
     getNativeInternalStorage(): BrowserCacheManager;
 
+    /** @internal */
     getBrowserCrypto(): ICrypto;
 
+    /** @internal */
     getPerformanceClient(): IPerformanceClient;
 
+    /** @internal */
     getNativeExtensionProvider(): NativeMessageHandler | undefined;
 
+    /** @internal */
     setNativeExtensionProvider(
         provider: NativeMessageHandler | undefined
     ): void;
 
+    /** @internal */
     getNativeAccountId(
         request: RedirectRequest | PopupRequest | SsoSilentRequest
     ): string;
 
+    /** @internal */
     getEventHandler(): EventHandler;
 
+    /** @internal */
     getNavigationClient(): INavigationClient;
 
+    /** @internal */
     getRedirectResponse(): Map<string, Promise<AuthenticationResult | null>>;
 
+    /** @internal */
     preflightBrowserEnvironmentCheck(
         interactionType: InteractionType,
         isAppEmbedded?: boolean
     ): void;
 
+    /** @internal */
     canUseNative(
         request: RedirectRequest | PopupRequest | SsoSilentRequest,
         accountId?: string
     ): boolean;
 
+    /** @internal */
     createPopupClient(correlationId?: string): PopupClient;
 
+    /** @internal */
     createSilentIframeClient(correlationId?: string): SilentIframeClient;
 }

lib/msal-browser/src/index.ts

@@ -14,14 +14,17 @@
  */
 
 import * as internals from "./internals";
+/** @internal */
 export { internals };
 
 export { PublicClientApplication } from "./app/PublicClientApplication";
+export { IController } from "./controllers/IController";
 export {
     Configuration,
     BrowserAuthOptions,
     CacheOptions,
     BrowserSystemOptions,
+    BrowserTelemetryOptions,
     BrowserConfiguration,
     DEFAULT_IFRAME_TIMEOUT_MS,
 } from "./config/Configuration";
@@ -70,6 +73,7 @@ export { AuthenticationResult } from "./response/AuthenticationResult";
 
 // Cache
 export { LoadTokenOptions } from "./cache/TokenCache";
+export { ITokenCache } from "./cache/ITokenCache";
 
 // Events
 export {
@@ -87,7 +91,11 @@ export {
     SignedHttpRequestOptions,
 } from "./crypto/SignedHttpRequest";
 
-export { PopupWindowAttributes } from "./request/PopupWindowAttributes";
+export {
+    PopupWindowAttributes,
+    PopupSize,
+    PopupPosition,
+} from "./request/PopupWindowAttributes";
 
 // Telemetry
 export { BrowserPerformanceClient } from "./telemetry/BrowserPerformanceClient";

lib/msal-browser/typedoc.json

@@ -0,0 +1,10 @@
+{
+    "extends": [
+        "../../typedoc.base.json"
+    ],
+    "entryPoints": [
+        "src/index.ts"
+    ],
+    "tsconfig": "tsconfig.build.json",
+    "readme": "./README.md"
+}

lib/msal-common/src/authority/Authority.ts

@@ -49,6 +49,7 @@ import { PerformanceEvents } from "../telemetry/performance/PerformanceEvent";
 /**
  * The authority class validates the authority URIs used by the user, and retrieves the OpenID Configuration Data from the
  * endpoint. It will store the pertinent config data in this object for use during token calls.
+ * @internal
  */
 export class Authority {
     // Canonical authority url string

lib/msal-common/src/authority/AuthorityFactory.ts

@@ -14,6 +14,7 @@ import { Logger } from "../logger/Logger";
 import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient";
 import { PerformanceEvents } from "../telemetry/performance/PerformanceEvent";
 
+/** @internal */
 export class AuthorityFactory {
     /**
      * Create an authority object of the correct type based on the url

lib/msal-common/src/cache/CacheManager.ts

@@ -43,6 +43,7 @@ import { StoreInCache } from "../request/StoreInCache";
 
 /**
  * Interface class which implement cache storage functions used by MSAL to perform validity checks, and store tokens.
+ * @internal
  */
 export abstract class CacheManager implements ICacheManager {
     protected clientId: string;
@@ -1491,6 +1492,7 @@ export abstract class CacheManager implements ICacheManager {
     }
 }
 
+/** @internal */
 export class DefaultStorageClass extends CacheManager {
     setAccount(): void {
         const notImplErr =

lib/msal-common/src/cache/entities/AccountEntity.ts

@@ -36,6 +36,7 @@ import { ProtocolMode } from "../../authority/ProtocolMode";
  *      idTokenClaims: Object containing claims parsed from ID token
  *      nativeAccountId: Account identifier on the native device
  * }
+ * @internal
  */
 export class AccountEntity {
     homeAccountId: string;

lib/msal-common/src/cache/entities/AuthorityMetadataEntity.ts

@@ -8,6 +8,7 @@ import { OpenIdConfigResponse } from "../../authority/OpenIdConfigResponse";
 import { AUTHORITY_METADATA_CONSTANTS } from "../../utils/Constants";
 import { TimeUtils } from "../../utils/TimeUtils";
 
+/** @internal */
 export class AuthorityMetadataEntity {
     aliases: Array<string>;
     preferred_cache: string;

lib/msal-common/src/cache/entities/CacheRecord.ts

@@ -9,6 +9,7 @@ import { RefreshTokenEntity } from "./RefreshTokenEntity";
 import { AccountEntity } from "./AccountEntity";
 import { AppMetadataEntity } from "./AppMetadataEntity";
 
+/** @internal */
 export class CacheRecord {
     account: AccountEntity | null;
     idToken: IdTokenEntity | null;

lib/msal-common/src/cache/utils/CacheTypes.ts

@@ -14,14 +14,20 @@ import { AuthorityMetadataEntity } from "../entities/AuthorityMetadataEntity";
 import { AuthenticationScheme } from "../../utils/Constants";
 import { ScopeSet } from "../../request/ScopeSet";
 
+/** @internal */
 export type AccountCache = Record<string, AccountEntity>;
+/** @internal */
 export type IdTokenCache = Record<string, IdTokenEntity>;
+/** @internal */
 export type AccessTokenCache = Record<string, AccessTokenEntity>;
+/** @internal */
 export type RefreshTokenCache = Record<string, RefreshTokenEntity>;
+/** @internal */
 export type AppMetadataCache = Record<string, AppMetadataEntity>;
 
 /**
  * Object type of all accepted cache types
+ * @internal
  */
 export type ValidCacheType =
     | AccountEntity
@@ -36,6 +42,7 @@ export type ValidCacheType =
 
 /**
  * Object type of all credential types
+ * @internal
  */
 export type ValidCredentialType =
     | IdTokenEntity

lib/msal-common/src/client/AuthorizationCodeClient.ts

@@ -46,6 +46,7 @@ import { PerformanceEvents } from "../telemetry/performance/PerformanceEvent";
 
 /**
  * Oauth2.0 Authorization Code client
+ * @internal
  */
 export class AuthorizationCodeClient extends BaseClient {
     // Flag to indicate if client is for hybrid spa auth code redemption

lib/msal-common/src/client/BaseClient.ts

@@ -28,6 +28,7 @@ import { BaseAuthRequest } from "../request/BaseAuthRequest";
 
 /**
  * Base application class which will construct requests to send to and handle responses from the Microsoft STS using the authorization code flow.
+ * @internal
  */
 export abstract class BaseClient {
     // Logger object

lib/msal-common/src/client/RefreshTokenClient.ts

@@ -40,6 +40,7 @@ import { PerformanceEvents } from "../telemetry/performance/PerformanceEvent";
 import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient";
 /**
  * OAuth2.0 refresh token client
+ * @internal
  */
 export class RefreshTokenClient extends BaseClient {
     constructor(

lib/msal-common/src/client/SilentFlowClient.ts

@@ -21,6 +21,7 @@ import { CacheOutcome } from "../utils/Constants";
 import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient";
 import { StringUtils } from "../utils/StringUtils";
 
+/** @internal */
 export class SilentFlowClient extends BaseClient {
     constructor(
         configuration: ClientConfiguration,

lib/msal-common/src/config/ClientConfiguration.ts

@@ -34,6 +34,7 @@ const DEFAULT_TOKEN_RENEWAL_OFFSET_SEC = 300;
  * - storageInterface           - Storage implementation
  * - systemOptions              - Additional library options
  * - clientCredentials          - Credentials options for confidential clients
+ * @internal
  */
 export type ClientConfiguration = {
     authOptions: AuthOptions;
@@ -77,6 +78,7 @@ export type CommonClientConfiguration = {
  * - clientCapabilities          - Array of capabilities which will be added to the claims.access_token.xms_cc request property on every network request.
  * - protocolMode                - Enum that represents the protocol that msal follows. Used for configuring proper endpoints.
  * - skipAuthorityMetadataCache      - A flag to choose whether to use or not use the local metadata cache during authority initialization. Defaults to false.
+ * @internal
  */
 export type AuthOptions = {
     clientId: string;

lib/msal-common/src/crypto/JoseHeader.ts

@@ -12,6 +12,7 @@ export type JoseHeaderOptions = {
     kid?: string;
 };
 
+/** @internal */
 export class JoseHeader {
     public typ?: JsonTypes;
     public alg?: string;

lib/msal-common/src/crypto/PopTokenGenerator.ts

@@ -33,6 +33,7 @@ const KeyLocation = {
 } as const;
 export type KeyLocation = (typeof KeyLocation)[keyof typeof KeyLocation];
 
+/** @internal */
 export class PopTokenGenerator {
     private cryptoUtils: ICrypto;
     private performanceClient?: IPerformanceClient;