From d6bdb1c9987e54a347874537025c17e70b546f36 Mon Sep 17 00:00:00 2001 From: Thomas Norling Date: Tue, 15 Aug 2023 13:32:00 -0700 Subject: [PATCH] Fix typedoc deployment workflow (#6321) Fixes typedoc deployment on PR merges. Typedocs have been updated manually --- .github/workflows/typedoc.yml | 4 ++-- ...-b69b070a-d2c5-4330-8cf1-9d41ffbc9749.json | 7 ++++++ ...-7a080449-1a09-4acf-b993-6370834eaec9.json | 7 ++++++ ...-88a3f3ff-51dd-4388-bb05-0988f32b4111.json | 7 ++++++ ...-ad549be5-8392-4a30-bfc9-65b0c6dc9774.json | 7 ++++++ ...-0de689eb-5e67-4678-b56d-474a62014a58.json | 7 ++++++ ...-93fd73f1-607d-4b5b-b9e7-e45c5e504e7c.json | 7 ++++++ extensions/msal-node-extensions/typedoc.json | 10 +++++++++ lib/msal-angular/typedoc.json | 10 +++++++++ .../src/app/IPublicClientApplication.ts | 1 + .../src/app/PublicClientApplication.ts | 3 ++- lib/msal-browser/src/config/Configuration.ts | 2 ++ .../src/controllers/IController.ts | 16 ++++++++++++++ lib/msal-browser/src/index.ts | 10 ++++++++- lib/msal-browser/typedoc.json | 10 +++++++++ lib/msal-common/src/authority/Authority.ts | 1 + .../src/authority/AuthorityFactory.ts | 1 + lib/msal-common/src/cache/CacheManager.ts | 2 ++ .../src/cache/entities/AccountEntity.ts | 1 + .../cache/entities/AuthorityMetadataEntity.ts | 1 + .../src/cache/entities/CacheRecord.ts | 1 + lib/msal-common/src/cache/utils/CacheTypes.ts | 7 ++++++ .../src/client/AuthorizationCodeClient.ts | 1 + lib/msal-common/src/client/BaseClient.ts | 1 + .../src/client/RefreshTokenClient.ts | 1 + .../src/client/SilentFlowClient.ts | 1 + .../src/config/ClientConfiguration.ts | 2 ++ lib/msal-common/src/crypto/JoseHeader.ts | 1 + .../src/crypto/PopTokenGenerator.ts | 1 + lib/msal-common/src/index.ts | 1 + lib/msal-common/src/network/NetworkManager.ts | 1 + .../src/network/ThrottlingUtils.ts | 1 + .../src/request/RequestParameterBuilder.ts | 1 + .../src/response/ResponseHandler.ts | 1 + .../server/ServerTelemetryManager.ts | 1 + lib/msal-common/typedoc.json | 10 +++++++++ lib/msal-node/src/config/Configuration.ts | 3 ++- lib/msal-node/src/index.ts | 3 +++ lib/msal-node/typedoc.json | 10 +++++++++ lib/msal-react/src/index.ts | 1 + lib/msal-react/src/utils/utilities.ts | 4 ++-- lib/msal-react/typedoc.json | 10 +++++++++ package-lock.json | 22 +++++++++---------- package.json | 2 +- typedoc.base.json | 8 +++++++ typedoc.json | 12 ++++------ 46 files changed, 194 insertions(+), 27 deletions(-) create mode 100644 change/@azure-msal-angular-b69b070a-d2c5-4330-8cf1-9d41ffbc9749.json create mode 100644 change/@azure-msal-browser-7a080449-1a09-4acf-b993-6370834eaec9.json create mode 100644 change/@azure-msal-common-88a3f3ff-51dd-4388-bb05-0988f32b4111.json create mode 100644 change/@azure-msal-node-ad549be5-8392-4a30-bfc9-65b0c6dc9774.json create mode 100644 change/@azure-msal-node-extensions-0de689eb-5e67-4678-b56d-474a62014a58.json create mode 100644 change/@azure-msal-react-93fd73f1-607d-4b5b-b9e7-e45c5e504e7c.json create mode 100644 extensions/msal-node-extensions/typedoc.json create mode 100644 lib/msal-angular/typedoc.json create mode 100644 lib/msal-browser/typedoc.json create mode 100644 lib/msal-common/typedoc.json create mode 100644 lib/msal-node/typedoc.json create mode 100644 lib/msal-react/typedoc.json create mode 100644 typedoc.base.json diff --git a/.github/workflows/typedoc.yml b/.github/workflows/typedoc.yml index 539835961e..5a36c29002 100644 --- a/.github/workflows/typedoc.yml +++ b/.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 diff --git a/change/@azure-msal-angular-b69b070a-d2c5-4330-8cf1-9d41ffbc9749.json b/change/@azure-msal-angular-b69b070a-d2c5-4330-8cf1-9d41ffbc9749.json new file mode 100644 index 0000000000..1cdae1c995 --- /dev/null +++ b/change/@azure-msal-angular-b69b070a-d2c5-4330-8cf1-9d41ffbc9749.json @@ -0,0 +1,7 @@ +{ + "type": "none", + "comment": "Typedocs", + "packageName": "@azure/msal-angular", + "email": "thomas.norling@microsoft.com", + "dependentChangeType": "none" +} diff --git a/change/@azure-msal-browser-7a080449-1a09-4acf-b993-6370834eaec9.json b/change/@azure-msal-browser-7a080449-1a09-4acf-b993-6370834eaec9.json new file mode 100644 index 0000000000..ad2785d5c9 --- /dev/null +++ b/change/@azure-msal-browser-7a080449-1a09-4acf-b993-6370834eaec9.json @@ -0,0 +1,7 @@ +{ + "type": "none", + "comment": "Typedocs", + "packageName": "@azure/msal-browser", + "email": "thomas.norling@microsoft.com", + "dependentChangeType": "none" +} diff --git a/change/@azure-msal-common-88a3f3ff-51dd-4388-bb05-0988f32b4111.json b/change/@azure-msal-common-88a3f3ff-51dd-4388-bb05-0988f32b4111.json new file mode 100644 index 0000000000..312c063601 --- /dev/null +++ b/change/@azure-msal-common-88a3f3ff-51dd-4388-bb05-0988f32b4111.json @@ -0,0 +1,7 @@ +{ + "type": "none", + "comment": "Typedocs", + "packageName": "@azure/msal-common", + "email": "thomas.norling@microsoft.com", + "dependentChangeType": "none" +} diff --git a/change/@azure-msal-node-ad549be5-8392-4a30-bfc9-65b0c6dc9774.json b/change/@azure-msal-node-ad549be5-8392-4a30-bfc9-65b0c6dc9774.json new file mode 100644 index 0000000000..00cc462808 --- /dev/null +++ b/change/@azure-msal-node-ad549be5-8392-4a30-bfc9-65b0c6dc9774.json @@ -0,0 +1,7 @@ +{ + "type": "none", + "comment": "Typedocs", + "packageName": "@azure/msal-node", + "email": "thomas.norling@microsoft.com", + "dependentChangeType": "none" +} diff --git a/change/@azure-msal-node-extensions-0de689eb-5e67-4678-b56d-474a62014a58.json b/change/@azure-msal-node-extensions-0de689eb-5e67-4678-b56d-474a62014a58.json new file mode 100644 index 0000000000..09ab593de9 --- /dev/null +++ b/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": "thomas.norling@microsoft.com", + "dependentChangeType": "none" +} diff --git a/change/@azure-msal-react-93fd73f1-607d-4b5b-b9e7-e45c5e504e7c.json b/change/@azure-msal-react-93fd73f1-607d-4b5b-b9e7-e45c5e504e7c.json new file mode 100644 index 0000000000..0a77ac7736 --- /dev/null +++ b/change/@azure-msal-react-93fd73f1-607d-4b5b-b9e7-e45c5e504e7c.json @@ -0,0 +1,7 @@ +{ + "type": "none", + "comment": "Typedocs", + "packageName": "@azure/msal-react", + "email": "thomas.norling@microsoft.com", + "dependentChangeType": "none" +} diff --git a/extensions/msal-node-extensions/typedoc.json b/extensions/msal-node-extensions/typedoc.json new file mode 100644 index 0000000000..fa42dab983 --- /dev/null +++ b/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" +} \ No newline at end of file diff --git a/lib/msal-angular/typedoc.json b/lib/msal-angular/typedoc.json new file mode 100644 index 0000000000..6cd17412d7 --- /dev/null +++ b/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" +} \ No newline at end of file diff --git a/lib/msal-browser/src/app/IPublicClientApplication.ts b/lib/msal-browser/src/app/IPublicClientApplication.ts index e8d24ec16e..07e3fbd91d 100644 --- a/lib/msal-browser/src/app/IPublicClientApplication.ts +++ b/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, diff --git a/lib/msal-browser/src/app/PublicClientApplication.ts b/lib/msal-browser/src/app/PublicClientApplication.ts index e275cea08d..c8739ecf3a 100644 --- a/lib/msal-browser/src/app/PublicClientApplication.ts +++ b/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.} - a promise that is fulfilled when this function has completed, or rejected if an error was raised. Returns the {@link AuthResponse} object + * @returns {Promise.} - 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(); diff --git a/lib/msal-browser/src/config/Configuration.ts b/lib/msal-browser/src/config/Configuration.ts index dc9663c305..22b2b2119a 100644 --- a/lib/msal-browser/src/config/Configuration.ts +++ b/lib/msal-browser/src/config/Configuration.ts @@ -95,6 +95,7 @@ export type BrowserAuthOptions = { skipAuthorityMetadataCache?: boolean; }; +/** @internal */ export type InternalAuthOptions = Required & { OIDCOptions: Required; }; @@ -220,6 +221,7 @@ export type Configuration = { telemetry?: BrowserTelemetryOptions; }; +/** @internal */ export type BrowserConfiguration = { auth: InternalAuthOptions; cache: Required; diff --git a/lib/msal-browser/src/controllers/IController.ts b/lib/msal-browser/src/controllers/IController.ts index 8af0bf8824..4534de7b01 100644 --- a/lib/msal-browser/src/controllers/IController.ts +++ b/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; + /** @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>; + /** @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; } diff --git a/lib/msal-browser/src/index.ts b/lib/msal-browser/src/index.ts index 10e42779a4..6ebc6b83f2 100644 --- a/lib/msal-browser/src/index.ts +++ b/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"; diff --git a/lib/msal-browser/typedoc.json b/lib/msal-browser/typedoc.json new file mode 100644 index 0000000000..fa42dab983 --- /dev/null +++ b/lib/msal-browser/typedoc.json @@ -0,0 +1,10 @@ +{ + "extends": [ + "../../typedoc.base.json" + ], + "entryPoints": [ + "src/index.ts" + ], + "tsconfig": "tsconfig.build.json", + "readme": "./README.md" +} \ No newline at end of file diff --git a/lib/msal-common/src/authority/Authority.ts b/lib/msal-common/src/authority/Authority.ts index 1e3ab14f87..9913ee378a 100644 --- a/lib/msal-common/src/authority/Authority.ts +++ b/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 diff --git a/lib/msal-common/src/authority/AuthorityFactory.ts b/lib/msal-common/src/authority/AuthorityFactory.ts index 863cd9c7f6..a0e6356338 100644 --- a/lib/msal-common/src/authority/AuthorityFactory.ts +++ b/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 diff --git a/lib/msal-common/src/cache/CacheManager.ts b/lib/msal-common/src/cache/CacheManager.ts index 1fff4a40db..05eed18d3a 100644 --- a/lib/msal-common/src/cache/CacheManager.ts +++ b/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 = diff --git a/lib/msal-common/src/cache/entities/AccountEntity.ts b/lib/msal-common/src/cache/entities/AccountEntity.ts index c02b9617ac..bac13ff1bf 100644 --- a/lib/msal-common/src/cache/entities/AccountEntity.ts +++ b/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; diff --git a/lib/msal-common/src/cache/entities/AuthorityMetadataEntity.ts b/lib/msal-common/src/cache/entities/AuthorityMetadataEntity.ts index a8014b7433..2e2583bdda 100644 --- a/lib/msal-common/src/cache/entities/AuthorityMetadataEntity.ts +++ b/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; preferred_cache: string; diff --git a/lib/msal-common/src/cache/entities/CacheRecord.ts b/lib/msal-common/src/cache/entities/CacheRecord.ts index a46784d7ad..2821dd2ad6 100644 --- a/lib/msal-common/src/cache/entities/CacheRecord.ts +++ b/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; diff --git a/lib/msal-common/src/cache/utils/CacheTypes.ts b/lib/msal-common/src/cache/utils/CacheTypes.ts index 2ad2ca6dce..01bb5d7389 100644 --- a/lib/msal-common/src/cache/utils/CacheTypes.ts +++ b/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; +/** @internal */ export type IdTokenCache = Record; +/** @internal */ export type AccessTokenCache = Record; +/** @internal */ export type RefreshTokenCache = Record; +/** @internal */ export type AppMetadataCache = Record; /** * 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 diff --git a/lib/msal-common/src/client/AuthorizationCodeClient.ts b/lib/msal-common/src/client/AuthorizationCodeClient.ts index b42c43db6a..a66e9792e6 100644 --- a/lib/msal-common/src/client/AuthorizationCodeClient.ts +++ b/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 diff --git a/lib/msal-common/src/client/BaseClient.ts b/lib/msal-common/src/client/BaseClient.ts index 4bab66e2e7..10db876e2d 100644 --- a/lib/msal-common/src/client/BaseClient.ts +++ b/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 diff --git a/lib/msal-common/src/client/RefreshTokenClient.ts b/lib/msal-common/src/client/RefreshTokenClient.ts index 2beabb7b8c..1e2c0bed09 100644 --- a/lib/msal-common/src/client/RefreshTokenClient.ts +++ b/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( diff --git a/lib/msal-common/src/client/SilentFlowClient.ts b/lib/msal-common/src/client/SilentFlowClient.ts index b3fb3c833e..aa94f83716 100644 --- a/lib/msal-common/src/client/SilentFlowClient.ts +++ b/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, diff --git a/lib/msal-common/src/config/ClientConfiguration.ts b/lib/msal-common/src/config/ClientConfiguration.ts index 34deaf2c88..ace908f6f4 100644 --- a/lib/msal-common/src/config/ClientConfiguration.ts +++ b/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; diff --git a/lib/msal-common/src/crypto/JoseHeader.ts b/lib/msal-common/src/crypto/JoseHeader.ts index c1dbbd4bef..3a6f27b9c1 100644 --- a/lib/msal-common/src/crypto/JoseHeader.ts +++ b/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; diff --git a/lib/msal-common/src/crypto/PopTokenGenerator.ts b/lib/msal-common/src/crypto/PopTokenGenerator.ts index de0ad540da..f8a137626e 100644 --- a/lib/msal-common/src/crypto/PopTokenGenerator.ts +++ b/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; diff --git a/lib/msal-common/src/index.ts b/lib/msal-common/src/index.ts index fe0334a4dd..6588bcfdec 100644 --- a/lib/msal-common/src/index.ts +++ b/lib/msal-common/src/index.ts @@ -117,6 +117,7 @@ export { NativeRequest } from "./request/NativeRequest"; export { NativeSignOutRequest } from "./request/NativeSignOutRequest"; export { RequestParameterBuilder } from "./request/RequestParameterBuilder"; export { StoreInCache } from "./request/StoreInCache"; +export { ClientAssertion } from "./account/ClientCredentials"; // Response export { AzureRegion } from "./authority/AzureRegion"; export { AzureRegionConfiguration } from "./authority/AzureRegionConfiguration"; diff --git a/lib/msal-common/src/network/NetworkManager.ts b/lib/msal-common/src/network/NetworkManager.ts index 4a785c46b1..05fe4455e0 100644 --- a/lib/msal-common/src/network/NetworkManager.ts +++ b/lib/msal-common/src/network/NetworkManager.ts @@ -29,6 +29,7 @@ export type UrlToHttpRequestOptions = { auth?: string; }; +/** @internal */ export class NetworkManager { private networkClient: INetworkModule; private cacheManager: CacheManager; diff --git a/lib/msal-common/src/network/ThrottlingUtils.ts b/lib/msal-common/src/network/ThrottlingUtils.ts index 3470ba6d53..22fb69bcc3 100644 --- a/lib/msal-common/src/network/ThrottlingUtils.ts +++ b/lib/msal-common/src/network/ThrottlingUtils.ts @@ -16,6 +16,7 @@ import { RequestThumbprint } from "./RequestThumbprint"; import { ThrottlingEntity } from "../cache/entities/ThrottlingEntity"; import { BaseAuthRequest } from "../request/BaseAuthRequest"; +/** @internal */ export class ThrottlingUtils { /** * Prepares a RequestThumbprint to be stored as a key. diff --git a/lib/msal-common/src/request/RequestParameterBuilder.ts b/lib/msal-common/src/request/RequestParameterBuilder.ts index 0cf4236c79..74f0a40269 100644 --- a/lib/msal-common/src/request/RequestParameterBuilder.ts +++ b/lib/msal-common/src/request/RequestParameterBuilder.ts @@ -28,6 +28,7 @@ import { StringUtils } from "../utils/StringUtils"; import { ServerTelemetryManager } from "../telemetry/server/ServerTelemetryManager"; import { ClientInfo } from "../account/ClientInfo"; +/** @internal */ export class RequestParameterBuilder { private parameters: Map; diff --git a/lib/msal-common/src/response/ResponseHandler.ts b/lib/msal-common/src/response/ResponseHandler.ts index 741baffd73..3daf18ecf1 100644 --- a/lib/msal-common/src/response/ResponseHandler.ts +++ b/lib/msal-common/src/response/ResponseHandler.ts @@ -40,6 +40,7 @@ import { PerformanceEvents } from "../telemetry/performance/PerformanceEvent"; /** * Class that handles response parsing. + * @internal */ export class ResponseHandler { private clientId: string; diff --git a/lib/msal-common/src/telemetry/server/ServerTelemetryManager.ts b/lib/msal-common/src/telemetry/server/ServerTelemetryManager.ts index abcb088ab0..0796a252e9 100644 --- a/lib/msal-common/src/telemetry/server/ServerTelemetryManager.ts +++ b/lib/msal-common/src/telemetry/server/ServerTelemetryManager.ts @@ -18,6 +18,7 @@ import { ServerTelemetryEntity } from "../../cache/entities/ServerTelemetryEntit import { StringUtils } from "../../utils/StringUtils"; import { RegionDiscoveryMetadata } from "../../authority/RegionDiscoveryMetadata"; +/** @internal */ export class ServerTelemetryManager { private cacheManager: CacheManager; private apiId: number; diff --git a/lib/msal-common/typedoc.json b/lib/msal-common/typedoc.json new file mode 100644 index 0000000000..fa42dab983 --- /dev/null +++ b/lib/msal-common/typedoc.json @@ -0,0 +1,10 @@ +{ + "extends": [ + "../../typedoc.base.json" + ], + "entryPoints": [ + "src/index.ts" + ], + "tsconfig": "tsconfig.build.json", + "readme": "./README.md" +} \ No newline at end of file diff --git a/lib/msal-node/src/config/Configuration.ts b/lib/msal-node/src/config/Configuration.ts index 43b628a299..e914500ad2 100644 --- a/lib/msal-node/src/config/Configuration.ts +++ b/lib/msal-node/src/config/Configuration.ts @@ -155,6 +155,7 @@ const DEFAULT_TELEMETRY_OPTIONS: Required = { }, }; +/** @internal */ export type NodeConfiguration = { auth: Required; broker: BrokerOptions; @@ -172,7 +173,7 @@ export type NodeConfiguration = { * @param telemetry - Telemetry options * * @returns Configuration - * @public + * @internal */ export function buildAppConfiguration({ auth, diff --git a/lib/msal-node/src/index.ts b/lib/msal-node/src/index.ts index 534550b2b9..b950b17baa 100644 --- a/lib/msal-node/src/index.ts +++ b/lib/msal-node/src/index.ts @@ -38,6 +38,8 @@ export { buildAppConfiguration, NodeAuthOptions, NodeSystemOptions, + BrokerOptions, + NodeTelemetryOptions, CacheOptions, } from "./config/Configuration"; export { ClientAssertion } from "./client/ClientAssertion"; @@ -70,6 +72,7 @@ export type { UsernamePasswordRequest } from "./request/UsernamePasswordRequest" export type { RefreshTokenRequest } from "./request/RefreshTokenRequest"; export type { SilentFlowRequest } from "./request/SilentFlowRequest"; export type { InteractiveRequest } from "./request/InteractiveRequest"; +export type { SignOutRequest } from "./request/SignOutRequest"; // Common Object Formats export { diff --git a/lib/msal-node/typedoc.json b/lib/msal-node/typedoc.json new file mode 100644 index 0000000000..fa42dab983 --- /dev/null +++ b/lib/msal-node/typedoc.json @@ -0,0 +1,10 @@ +{ + "extends": [ + "../../typedoc.base.json" + ], + "entryPoints": [ + "src/index.ts" + ], + "tsconfig": "tsconfig.build.json", + "readme": "./README.md" +} \ No newline at end of file diff --git a/lib/msal-react/src/index.ts b/lib/msal-react/src/index.ts index 30792bc524..3aae02637d 100644 --- a/lib/msal-react/src/index.ts +++ b/lib/msal-react/src/index.ts @@ -25,6 +25,7 @@ export { UnauthenticatedTemplate } from "./components/UnauthenticatedTemplate"; export { MsalAuthenticationTemplate } from "./components/MsalAuthenticationTemplate"; export { withMsal } from "./components/withMsal"; +export { Subtract, SetComplement, SetDifference } from "./utils/utilities"; export { useMsal } from "./hooks/useMsal"; export { useAccount } from "./hooks/useAccount"; diff --git a/lib/msal-react/src/utils/utilities.ts b/lib/msal-react/src/utils/utilities.ts index a2d2b14c05..d6da4551ea 100644 --- a/lib/msal-react/src/utils/utilities.ts +++ b/lib/msal-react/src/utils/utilities.ts @@ -22,8 +22,8 @@ export function getChildrenOrFunction( * Utility types * Reference: https://github.com/piotrwitek/utility-types */ -type SetDifference = A extends B ? never : A; -type SetComplement = SetDifference; +export type SetDifference = A extends B ? never : A; +export type SetComplement = SetDifference; export type Subtract = Pick< T, SetComplement diff --git a/lib/msal-react/typedoc.json b/lib/msal-react/typedoc.json new file mode 100644 index 0000000000..fa42dab983 --- /dev/null +++ b/lib/msal-react/typedoc.json @@ -0,0 +1,10 @@ +{ + "extends": [ + "../../typedoc.base.json" + ], + "entryPoints": [ + "src/index.ts" + ], + "tsconfig": "tsconfig.build.json", + "readme": "./README.md" +} \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 9eb098e8ae..96c5c9cdb6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -48,7 +48,7 @@ "rimraf": "^3.0.0", "semver": "^7.3.4", "ts-node": "^8.10.2", - "typedoc": "^0.23.28", + "typedoc": "^0.24.0", "typescript": "^4.9.5" } }, @@ -48215,14 +48215,14 @@ } }, "node_modules/typedoc": { - "version": "0.23.28", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.23.28.tgz", - "integrity": "sha512-9x1+hZWTHEQcGoP7qFmlo4unUoVJLB0H/8vfO/7wqTnZxg4kPuji9y3uRzEu0ZKez63OJAUmiGhUrtukC6Uj3w==", + "version": "0.24.8", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.24.8.tgz", + "integrity": "sha512-ahJ6Cpcvxwaxfu4KtjA8qZNqS43wYt6JL27wYiIgl1vd38WW/KWX11YuAeZhuz9v+ttrutSsgK+XO1CjL1kA3w==", "dev": true, "dependencies": { "lunr": "^2.3.9", - "marked": "^4.2.12", - "minimatch": "^7.1.3", + "marked": "^4.3.0", + "minimatch": "^9.0.0", "shiki": "^0.14.1" }, "bin": { @@ -48232,7 +48232,7 @@ "node": ">= 14.14" }, "peerDependencies": { - "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x" + "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x" } }, "node_modules/typedoc/node_modules/brace-expansion": { @@ -48245,15 +48245,15 @@ } }, "node_modules/typedoc/node_modules/minimatch": { - "version": "7.4.6", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-7.4.6.tgz", - "integrity": "sha512-sBz8G/YjVniEz6lKPNpKxXwazJe4c19fEfV2GDMX6AjFz+MX9uDWIZW8XreVhkFW3fkIdTv/gxWr/Kks5FFAVw==", + "version": "9.0.3", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", + "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", "dev": true, "dependencies": { "brace-expansion": "^2.0.1" }, "engines": { - "node": ">=10" + "node": ">=16 || 14 >=14.17" }, "funding": { "url": "https://github.com/sponsors/isaacs" diff --git a/package.json b/package.json index 6748982ac6..9f5157e1ab 100644 --- a/package.json +++ b/package.json @@ -31,7 +31,7 @@ "rimraf": "^3.0.0", "semver": "^7.3.4", "ts-node": "^8.10.2", - "typedoc": "^0.23.28", + "typedoc": "^0.24.0", "typescript": "^4.9.5" }, "repository": { diff --git a/typedoc.base.json b/typedoc.base.json new file mode 100644 index 0000000000..ff36c3d777 --- /dev/null +++ b/typedoc.base.json @@ -0,0 +1,8 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "includeVersion": true, + "excludePrivate": true, + "excludeProtected": true, + "excludeExternals": true, + "excludeInternal": true +} \ No newline at end of file diff --git a/typedoc.json b/typedoc.json index f0d3a0f145..27331eb4e1 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,14 +1,10 @@ { "entryPoints": [ - "lib/msal-common/src/index.ts", - "lib/msal-browser/src/index.ts", - "lib/msal-node/src/index.ts", - "lib/msal-react/src/index.ts", - "lib/msal-angular/src/public-api.ts", + "lib/*", + "extensions/msal-node-extensions" ], + "entryPointStrategy": "packages", + "includeVersion": true, "out": "./ref", - "excludePrivate": true, - "excludeProtected": true, - "excludeExternals": true, "readme": "./README.md" } \ No newline at end of file