diff --git a/.openpublishing.publish.config.json b/.openpublishing.publish.config.json index c7b304e..5c37318 100644 --- a/.openpublishing.publish.config.json +++ b/.openpublishing.publish.config.json @@ -41,20 +41,12 @@ "sync_notification_subscribers": [], "branches_to_filter": [], "need_preview_pull_request": true, - "dependent_repositories": [ - { - "path_to_root": "_themes", - "url": "https://github.com/Microsoft/templates.docs.msft", - "branch": "main", - "branch_mapping": {} - } - ], "branch_target_mapping": {}, "docs_build_engine": {}, "skip_source_output_uploading": false, "JoinTOCPlugin": [ { - "TopLevelTOC": "msal/docs-ref-toc/fxtoc.yml", + "TopLevelTOC": "msal/docs-ref-toc/.yml", "ReferenceTOC": "msal/docs-ref-autogen/toc.yml", "ReferenceTOCUrl": "/javascript/api/microsoft-authentication-library-js/toc.json?view=msal-js-latest", "ConceptualTOCUrl": "/microsoft-authentication-library-js/toc.json", @@ -67,6 +59,22 @@ } } ], + "dependent_repositories": [ + { + "path_to_root": "_themes", + "url": "https://github.com/Microsoft/templates.docs.msft", + "branch": "main", + "branch_mapping": {} + }, + { + "path_to_root": "msal-javascript-conceptual/lcontent", + "url": "https://github.com/AzureAD/microsoft-authentication-library-for-js", + "branch": "dev", + "include_in_build": true, + "branch_mapping": {} + } + ], + "branch_target_mapping": {}, "dependent_packages": [ { "id": "opbuild.templates.uref", diff --git a/msal-javascript-conceptual/docfx.json b/msal-javascript-conceptual/docfx.json index 5b4e445..4ac280c 100644 --- a/msal-javascript-conceptual/docfx.json +++ b/msal-javascript-conceptual/docfx.json @@ -1,23 +1,72 @@ { "build": { "content": [ + { + "src": "lcontent/lib/msal-angular/docs", + "dest": "msal-angular", + "files": [ + "**/*.md" + ] + }, + { + "src": "lcontent/lib/msal-browser/docs", + "dest": "msal-browser", + "files": [ + "**/*.md" + ] + }, + { + "src": "lcontent/lib/msal-common/docs", + "dest": "msal-common", + "files": [ + "**/*.md" + ] + }, + { + "src": "lcontent/lib/msal-node/docs", + "dest": "msal-node", + "files": [ + "**/*.md" + ] + }, + { + "src": "lcontent/lib/msal-react/docs", + "dest": "msal-react", + "files": [ + "**/*.md" + ] + }, + { + "src": "lcontent/extensions/docs", + "dest": "extensions", + "files": [ + "**/*.md" + ] + }, { "files": [ "**/*.md", "**/*.yml" ], "exclude": [ + "**/README.md", + "**/CHANGELOG.md", + "**/LICENSE.md", + "**/SECURITY.md", + "**/CONTRIBUTING.md", "**/obj/**", "**/includes/**", "_themes/**", "_themes.pdf/**", "**/docfx.json", "_repo.en-us/**", - "README.md", "LICENSE", "LICENSE-CODE", "ThirdPartyNotices.md", - "SECURITY.md" + "lcontent/*.yml", + "lcontent/build/*.yml", + "lcontent/extensions/msal-node-extensions/**", + "lcontent/extensions/samples/**" ] } ], diff --git a/msal-javascript-conceptual/index.md b/msal-javascript-conceptual/index.md index 04c787d..da799ca 100644 --- a/msal-javascript-conceptual/index.md +++ b/msal-javascript-conceptual/index.md @@ -1 +1,12 @@ -# Welcome to msal-javascript-conceptual! \ No newline at end of file +--- +author: Dickson-Mwendia +ms.service: active-directory +ms.topic: include +ms.date: 04/12/2023 +ms.author: dmwendia +--- + +# Welcome to msal-javascript-conceptual! + + +J \ No newline at end of file diff --git a/msal/docfx.json b/msal/docfx.json index d95aa9d..5433128 100644 --- a/msal/docfx.json +++ b/msal/docfx.json @@ -44,8 +44,8 @@ "files": [ "**/*.md" ], - "src": "overview", - "dest": "api/overview", + "src": "msal", + "dest": "api", "exclude": [], "version": "msal-js-latest" }, diff --git a/msal/docs-ref-toc/fxtoc.yml b/msal/docs-ref-toc/fxtoc.yml index 4b0c332..5f30444 100644 --- a/msal/docs-ref-toc/fxtoc.yml +++ b/msal/docs-ref-toc/fxtoc.yml @@ -1,7 +1,11 @@ -- name: SDK reference - uid: msal.sdk.landingPage.reference - landingPageType: Root +- name: MSAL.js Overview expanded: true - href: ~/overview/msal-overview.md - children: - - '**' \ No newline at end of file + href: ~/msal/msal-overview.md +- name: MSAL Browser + items: + - name: Initialization of MSAL + href: ~/msal/browser/initialization.md + - name: Sign in users + href: ~/msal/browser/login-user.md + - name: Acquire tokens + href: ~/msal/browser/acquire-token.md \ No newline at end of file diff --git a/msal/overview/PackageStructure.png b/msal/overview/PackageStructure.png deleted file mode 100644 index e4e4b32..0000000 Binary files a/msal/overview/PackageStructure.png and /dev/null differ diff --git a/msal/overview/msal-overview.md b/msal/overview/msal-overview.md deleted file mode 100644 index 94b6374..0000000 --- a/msal/overview/msal-overview.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: Overview -description: Overview of the Microsoft Authentication Libraries for JavaScript -services: active-directory -author: Dickson-Mwendia -manager: CelesteDG - -ms.service: active-directory -ms.subservice: develop -ms.topic: reference -ms.workload: identity -ms.date: 01/10/2023 -ms.author: dmwendia ---- -# Microsoft Authentication Library for JavaScript (MSAL.js) - -The Microsoft Authentication Library for JavaScript enables both client-side and server-side JavaScript applications to authenticate users using [Azure Active Directory](/../../azure/active-directory/develop/v2-overview) (Azure AD) for work and school accounts, Microsoft personal accounts (MSA), and social identity providers like Facebook, Google, LinkedIn, Microsoft accounts, etc. through [Azure AD B2C](/../../azure/active-directory-b2c/active-directory-b2c-overview#identity-providers) service. It also enables your app to get tokens to access [Microsoft Cloud](https://www.microsoft.com/enterprise) services such as [Microsoft Graph](https://graph.microsoft.io). - - -## Core and wrapper libraries - -The [`lib`](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/lib) folder contains the source code for our libraries in active development. You will also find all the details about **installing the libraries** in their respective README.md files. - -- **Microsoft Authentication Library for Node.js v1.x:** A [Node.js](https://nodejs.org/en/) library that enables authentication and token acquisition with the Microsoft Identity platform in JavaScript applications. Implements the following OAuth 2.0 protocols and is [OpenID-compliant](/../../azure/active-directory/develop/v2-protocols-oidc): - - [Authorization Code Grant](https://oauth.net/2/grant-types/authorization-code/) with [PKCE](https://oauth.net/2/pkce/) - - [Device Code Grant](https://oauth.net/2/grant-types/device-code/) - - [Refresh Token Grant](https://oauth.net/2/grant-types/refresh-token/) - - [Client Credential Grant](https://oauth.net/2/grant-types/client-credentials/) - -- **Microsoft Authentication Library for JavaScript v2.x**: A browser-based, framework-agnostic browser library that enables authentication and token acquisition with the Microsoft Identity platform in JavaScript applications. Implements the OAuth 2.0 [Authorization Code Flow with PKCE](/../../azure/active-directory/develop/v2-oauth2-auth-code-flow), and is [OpenID-compliant](/../../azure/active-directory/develop/v2-protocols-oidc). - -- **Microsoft Authentication Library for React v1.x**: A wrapper of the msal-browser 2.x library for apps using React. - -- **Microsoft Authentication Library for Angular v2.x**: A wrapper of the msal-browser 2.x library for apps using Angular framework. - -- **Microsoft Authentication Library for JavaScript v1.x**: A browser-based, framework-agnostic core library that enables authentication and token acquisition with the Microsoft Identity platform in JavaScript applications. Implements the OAuth 2.0 [Implicit Grant Flow](/../../azure/active-directory/develop/v2-oauth2-implicit-grant-flow), and is [OpenID-compliant](/../../azure/active-directory/develop/v2-protocols-oidc). - -- [Microsoft Authentication Library for Angular](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/msal-angular-v1/lib/msal-angular): A wrapper of the core 1.x library for apps using Angular framework. - -## Package structure - -There are a number of different packages meant for different platforms. You can see the relationship between packages and different authentication flows they implement in the package structure below. - -![Package Structure](PackageStructure.png) - -## Samples - -The [`code samples`](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples) demonstrate usage of the Microsoft authentication libraries for JavaScript with the identity platform. Each code sample includes a `README.md` file describing how to build the project (if applicable) and run the sample application. - -For a complete list of samples targeting JavaScript and other languages, frameworks, and platforms, please refer to the [Microsoft identity platform code samples](/../../azure/active-directory/develop/sample-v2-code). - - -## Package versioning - -All of our libraries follow [semantic versioning](https://semver.org). We recommend using the latest version of each library to ensure you have the latest security patches and bug fixes. - -## Community help and support - -- [FAQs](https://github.com/AzureAD/microsoft-authentication-library-for-js/wiki/FAQs) for access to our frequently asked questions. - -- [Stack Overflow](http://stackoverflow.com/questions/tagged/msal) using "msal" and "msal.js" tag. - - -## Security reporting - -If you find a security issue with our libraries or services [please report it to the Microsoft Security Response Center (MSRC)](https://aka.ms/report-security-issue) with as much detail as possible. Your submission may be eligible for a bounty through the [Microsoft Bounty](https://aka.ms/bugbounty) program. Please do not post security issues to GitHub Issues or any other public site. We will contact you shortly upon receiving the information. If you'd like to get notifications of when security incidents occur, [subscribe to security advisory alerts](https://msrc-blog.microsoft.com/2022/08/09/security-update-guide-notification-system-news-create-your-profile-now/). \ No newline at end of file