Create the msal-custom-auth package for supporting the external ID authentication (sign-in, sign-up and SSPR)

.github/issue_template_bot.json

@@ -17,6 +17,11 @@
                         "@azure/msal-node"
                     ]
                 },
+                "msal-custom-auth": {
+                    "searchStrings": [
+                        "@azure/msal-custom-auth"
+                    ]
+                },
                 "adal-node": {
                     "searchStrings": [
                         "adal-node"
@@ -93,4 +98,4 @@
     "incompleteTemplateMessage": "Please update the original issue and make sure to fill out the entire issue template so we can better assist you.",
     "noTemplateMessage": "Please open a new issue and use one of the provided issue templates. Thanks!",
     "noTemplateClose": true
-}
+}

.github/labeler.yml

@@ -10,6 +10,8 @@ msal-browser:
   - lib/msal-browser/**/*
 msal-react:
   - lib/msal-react/**/*
+msal-custom-auth:
+  - lib/msal-custom-auth/**/*
 samples:
   - samples/**/*
 documentation:

.pipelines/1p-build.yml

@@ -22,7 +22,7 @@ resources:
         - repository: 1P
           type: git
           name: IDDP/msal-javascript-1p
-          ref: master
+          ref: custom-auth/pipeline # TODO: change back to master after pipeline is working
 
 extends:
     template: v2/OneBranch.NonOfficial.CrossPlat.yml@templates # https://aka.ms/obpipelines/templates
@@ -60,6 +60,11 @@ extends:
                         libName: msal-react
                         path: "lib/"
                         npmInstallTimeout: ${{ parameters.npmInstallTimeout }}
+                  - template: .pipelines/templates/ci-template.yml@1P
+                    parameters:
+                        libName: msal-custom-auth
+                        path: "lib/"
+                        npmInstallTimeout: ${{ parameters.npmInstallTimeout }}
                   - template: .pipelines/templates/ci-template.yml@1P
                     parameters:
                         libName: msal-angular

.pipelines/3p-e2e.yml

@@ -8,8 +8,8 @@ parameters:
       type: string
       default: "windows"
       values:
-        - "windows"
-        - "linux"
+          - "windows"
+          - "linux"
     - name: "runBrowserTests"
       displayName: "Run Browser Tests"
       type: boolean
@@ -26,6 +26,10 @@ parameters:
       displayName: "Run Angular Tests"
       type: boolean
       default: true
+    - name: "runCustomAuthTests"
+      displayName: "Run Custom Auth Tests"
+      type: boolean
+      default: true
     - name: "npmInstallTimeout"
       displayName: "NPM Install Timeout (Tests)"
       type: number
@@ -50,7 +54,7 @@ resources:
         - repository: 1P
           type: git
           name: IDDP/msal-javascript-1p
-          ref: master
+          ref: custom-auth/pipeline # TODO: change back to master after pipeline is working
 extends:
     template: v2/OneBranch.NonOfficial.CrossPlat.yml@templates # https://aka.ms/obpipelines/templates
     parameters:
@@ -62,75 +66,89 @@ extends:
             - stage: e2e_test
               displayName: "3P E2E Tests"
               jobs:
-                - ${{ if eq(parameters.runBrowserTests, true) }}:
-                  - template: .pipelines/templates/e2e-tests.yml@1P
-                    parameters:
-                        jobName: "validate_msal_browser"
-                        targetLib: "msal-browser"
-                        poolType: ${{ parameters.poolType }}
-                        stage: "CI"
-                        sourceRepo: ${{ variables.sourceRepo }}
-                        sourceBranch: ${{ variables.sourceBranch }}
-                        workspace: "samples/msal-browser-samples"
-                        samples:
-                            - "client-capabilities"
-                            - "onPageLoad"
-                            - "pop"
-                            - "customizable-e2e-test"
-                        debug: ${{ parameters.debug }}
-                        npmInstallTimeout: ${{ parameters.npmInstallTimeout }}
-                - ${{ if eq(parameters.runNodeTests, true) }}:
-                  - template: .pipelines/templates/e2e-tests.yml@1P
-                    parameters:
-                        jobName: "validate_msal_node"
-                        targetLib: "msal-node"
-                        poolType: ${{ parameters.poolType }}
-                        stage: "CI"
-                        sourceRepo: ${{ variables.sourceRepo }}
-                        sourceBranch: ${{ variables.sourceBranch }}
-                        workspace: "samples/msal-node-samples"
-                        nodeVersions: [16, 18, 20, 22]
-                        samples:
-                            - "auth-code"
-                            - "auth-code-cli-app"
-                            - "client-credentials"
-                            - "client-credentials-with-cert-from-key-vault"
-                            - "device-code"
-                            - "silent-flow"
-                            - "b2c-user-flows"
-                            # - "on-behalf-of"
-                        debug: ${{ parameters.debug }}
-                        npmInstallTimeout: ${{ parameters.npmInstallTimeout }}
-                - ${{ if eq(parameters.runReactTests, true) }}:
-                  - template: .pipelines/templates/e2e-tests.yml@1P
-                    parameters:
-                        jobName: "validate_msal_react"
-                        targetLib: "msal-react"
-                        poolType: ${{ parameters.poolType }}
-                        stage: "CI"
-                        sourceRepo: ${{ variables.sourceRepo }}
-                        sourceBranch: ${{ variables.sourceBranch }}
-                        workspace: "samples/msal-react-samples"
-                        samples:
-                            - "nextjs-sample"
-                            - "react-router-sample"
-                            - "typescript-sample"
-                            - "b2c-sample"
-                        debug: ${{ parameters.debug }}
-                        npmInstallTimeout: ${{ parameters.npmInstallTimeout }}
-                - ${{ if eq(parameters.runAngularTests, true) }}:
-                  - template: .pipelines/templates/e2e-tests.yml@1P
-                    parameters:
-                        jobName: "validate_msal_angular"
-                        targetLib: "msal-angular"
-                        poolType: ${{ parameters.poolType }}
-                        stage: "CI"
-                        sourceRepo: ${{ variables.sourceRepo }}
-                        sourceBranch: ${{ variables.sourceBranch }}
-                        workspace: "samples/msal-angular-samples"
-                        samples:
-                            - "angular-b2c-sample"
-                            - "angular-modules-sample"
-                            - "angular-standalone-sample"
-                        debug: ${{ parameters.debug }}
-                        npmInstallTimeout: ${{ parameters.npmInstallTimeout }}
+                  - ${{ if eq(parameters.runBrowserTests, true) }}:
+                        - template: .pipelines/templates/e2e-tests.yml@1P
+                          parameters:
+                              jobName: "validate_msal_browser"
+                              targetLib: "msal-browser"
+                              poolType: ${{ parameters.poolType }}
+                              stage: "CI"
+                              sourceRepo: ${{ variables.sourceRepo }}
+                              sourceBranch: ${{ variables.sourceBranch }}
+                              workspace: "samples/msal-browser-samples"
+                              samples:
+                                  - "client-capabilities"
+                                  - "onPageLoad"
+                                  - "pop"
+                                  - "customizable-e2e-test"
+                              debug: ${{ parameters.debug }}
+                              npmInstallTimeout: ${{ parameters.npmInstallTimeout }}
+                  - ${{ if eq(parameters.runNodeTests, true) }}:
+                        - template: .pipelines/templates/e2e-tests.yml@1P
+                          parameters:
+                              jobName: "validate_msal_node"
+                              targetLib: "msal-node"
+                              poolType: ${{ parameters.poolType }}
+                              stage: "CI"
+                              sourceRepo: ${{ variables.sourceRepo }}
+                              sourceBranch: ${{ variables.sourceBranch }}
+                              workspace: "samples/msal-node-samples"
+                              nodeVersions: [16, 18, 20, 22]
+                              samples:
+                                  - "auth-code"
+                                  - "auth-code-cli-app"
+                                  - "client-credentials"
+                                  - "client-credentials-with-cert-from-key-vault"
+                                  - "device-code"
+                                  - "silent-flow"
+                                  - "b2c-user-flows"
+                                  # - "on-behalf-of"
+                              debug: ${{ parameters.debug }}
+                              npmInstallTimeout: ${{ parameters.npmInstallTimeout }}
+                  - ${{ if eq(parameters.runReactTests, true) }}:
+                        - template: .pipelines/templates/e2e-tests.yml@1P
+                          parameters:
+                              jobName: "validate_msal_react"
+                              targetLib: "msal-react"
+                              poolType: ${{ parameters.poolType }}
+                              stage: "CI"
+                              sourceRepo: ${{ variables.sourceRepo }}
+                              sourceBranch: ${{ variables.sourceBranch }}
+                              workspace: "samples/msal-react-samples"
+                              samples:
+                                  - "nextjs-sample"
+                                  - "react-router-sample"
+                                  - "typescript-sample"
+                                  - "b2c-sample"
+                              debug: ${{ parameters.debug }}
+                              npmInstallTimeout: ${{ parameters.npmInstallTimeout }}
+                  - ${{ if eq(parameters.runAngularTests, true) }}:
+                        - template: .pipelines/templates/e2e-tests.yml@1P
+                          parameters:
+                              jobName: "validate_msal_angular"
+                              targetLib: "msal-angular"
+                              poolType: ${{ parameters.poolType }}
+                              stage: "CI"
+                              sourceRepo: ${{ variables.sourceRepo }}
+                              sourceBranch: ${{ variables.sourceBranch }}
+                              workspace: "samples/msal-angular-samples"
+                              samples:
+                                  - "angular-b2c-sample"
+                                  - "angular-modules-sample"
+                                  - "angular-standalone-sample"
+                              debug: ${{ parameters.debug }}
+                              npmInstallTimeout: ${{ parameters.npmInstallTimeout }}
+                  - ${{ if eq(parameters.runCustomAuthTests, true) }}:
+                        - template: .pipelines/templates/e2e-tests.yml@1P
+                          parameters:
+                              jobName: "validate_msal_custom_auth"
+                              targetLib: "msal-custom-auth"
+                              poolType: ${{ parameters.poolType }}
+                              stage: "CI"
+                              sourceRepo: ${{ variables.sourceRepo }}
+                              sourceBranch: ${{ variables.sourceBranch }}
+                              workspace: "samples/msal-custom-auth-samples"
+                              samples:
+                                  - "sample-sample"
+                              debug: ${{ parameters.debug }}
+                              npmInstallTimeout: ${{ parameters.npmInstallTimeout }}

.vscode/settings.json

@@ -41,6 +41,10 @@
         {
             "name": "msal-node-extensions",
             "rootPath": "extensions/msal-node-extensions"
+        },
+        {
+            "name": "msal-custom-auth",
+            "rootPath": "lib/msal-custom-auth"
         }
     ]
 }

CODEOWNERS

@@ -20,6 +20,10 @@
 /lib/msal-react/ @tnorling @jo-arroyo @peterzenz
 /samples/msal-react-samples/ @tnorling @jo-arroyo @peterzenz
 
+# MSAL Custom Auth
+/lib/msal-custom-auth/ @yongdiw @shenj @albanx
+/samples/msal-custom-auth-samples/ @yongdiw @shenj @albanx
+
 # Build
 /build/ @sameerag @tnorling @hectormmg @peterzenz
 /release-scripts/ @sameerag @tnorling @hectormmg @peterzenz

change/@azure-msal-browser-c26b89bf-2543-4528-8b24-904bc6ca5742.json

@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Expose components used by the msal-custom-auth",
+  "packageName": "@azure/msal-browser",
+  "email": "shen.jian@live.com",
+  "dependentChangeType": "patch"
+}

change/@azure-msal-custom-auth-89c01ce0-74fa-4ea3-9f21-f04d46e1ba34.json

@@ -0,0 +1,7 @@
+{
+  "type": "none",
+  "comment": "Create a new package named msal-custom-auth. This package will be used for the exteral IDs about sign-in, sign-up, password-reset and retrieve accounts and tokens from cache.",
+  "packageName": "@azure/msal-custom-auth",
+  "email": "shen.jian@live.com",
+  "dependentChangeType": "none"
+}

contributing.md

@@ -121,6 +121,10 @@ Once installed, you have the option to configure the jest environment for furthe
             "name": "msal-react",
             "rootPath": "lib/msal-react"
         },
+        {
+            "name": "msal-custom-auth",
+            "rootPath": "lib/msal-custom-auth"
+        },
         {
             "name": "msal-node-extensions",
             "rootPath": "extensions/msal-node-extensions"