fix(component): make passport packages optional (#156)

* fix(component): make passport packages optional

All passport packages are made optional, and the user should install them only if required.
BREAKING
CHANGE:
change import path for specific passport strategies
GH-125

BREAKING CHANGE:
rebased with master

* fix(component): allpassport packages made optional

All passport packages are made optional, and the user should install them only if required.
BREAKING
CHANGE:
changes for seprating passport packages
GH-125

* fix(component): added description in readme

added description in readme
GH-125

* fix(chore): sonar issue fix

fix for Unexpected lexical declaration in case block

GH-125

* fix(chore): fixed sonar issue

fixed sonar issue Refactor this function to reduce its Cognitive Complexity

GH-125

* fix(chore): fixed sonar issue

fixed sonar issue replace this union type with a type alias.
GH-125

* fix(chore): fixed sonar issue

disabled sonar issue for Promise returned in function argument where a void return was
expected
GH-125

* fix(chore): sonar fixes

sonar fixes

GH-125

* fix(chore): fixed sonar issues

fixed sonar issues

GH-125

* fix(chore): fixed sonar issue

fixed sonar issue

GH-125

* fix(chore): fixed sonar issue

fixed sonar issue

GH-125

* fix(chore): code review comment fix

code review comment fix

GH-125

---------

Co-authored-by: Karunesh Mani Tripathi <[email protected]>

Author: RaghavaroraSF

.gitignore

@@ -4,7 +4,7 @@ logs
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
-
+.history/
 # Runtime data
 pids
 *.pid

.vscode/settings.json

@@ -1,15 +1,15 @@
 {
-  "editor.rulers": [80],
+  "editor.rulers": [
+    80
+  ],
   "editor.tabCompletion": "on",
   "editor.tabSize": 2,
   "editor.trimAutoWhitespace": true,
   "editor.formatOnSave": true,
-
   "sonarlint.connectedMode.project": {
     "serverId": "sf_sonar",
     "projectKey": "sourcefuse_loopback4-authentication"
   },
-
   "files.exclude": {
     "**/.DS_Store": true,
     "**/.git": true,
@@ -20,6 +20,10 @@
   },
   "files.insertFinalNewline": true,
   "files.trimTrailingWhitespace": true,
-
-  "typescript.tsdk": "./node_modules/typescript/lib"
+  "typescript.tsdk": "./node_modules/typescript/lib",
+  "cSpell.words": [
+    "insta",
+    "keycloack",
+    "keycloak"
+  ]
 }

README.md

@@ -81,6 +81,7 @@ Once this is done, you are ready to configure any of the available strategy in t
 
 ### Oauth2-client-password
 
+In order to use it, run `npm install passport-oauth2-client-password`.
 First, create an AuthClient model implementing the IAuthClient interface. The purpose of this model is to store oauth registered clients for the app in the DB. See sample below.
 
 ```ts
@@ -243,6 +244,7 @@ For accessing the authenticated AuthClient model reference, you can inject the C
 
 ### Http-bearer
 
+In order to use it, run `npm install passport-http-bearer`.
 First, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.
 
 ```ts
@@ -423,6 +425,7 @@ For accessing the authenticated AuthUser model reference, you can inject the CUR
 
 ### local
 
+In order to use it, run `npm install passport-local`.
 First, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.
 
 ```ts
@@ -597,6 +600,7 @@ For accessing the authenticated AuthUser model reference, you can inject the CUR
 
 ### Oauth2-resource-owner-password
 
+In order to use it, run `npm install passport-oauth2-resource-owner-password`.
 First, create an AuthClient model implementing the IAuthClient interface. The purpose of this model is to store oauth registered clients for the app in the DB. See sample below.
 
 ```ts
@@ -1018,6 +1022,7 @@ For accessing the authenticated AuthUser model reference, you can inject the CUR
 
 ### Google Oauth 2
 
+In order to use it, run `npm install passport-google-oauth20` and `npm install @types/passport-google-oauth20`.
 First, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.
 
 ```ts
@@ -1174,6 +1179,18 @@ this.bind(Strategies.Passport.GOOGLE_OAUTH2_VERIFIER).toProvider(
 );
 ```
 
+Now, bind this provider to the application in application.ts.
+
+```ts
+import { GoogleAuthStrategyFactoryProvider } from 'loopback4-authentication/passport-google-oauth2';
+```
+
+```ts
+this.bind(Strategies.Passport.GOOGLE_OAUTH2_STRATEGY_FACTORY.key).toProvider(
+    GoogleAuthStrategyFactoryProvider
+  );
+```
+
 Finally, add the authenticate function as a sequence action to sequence.ts.
 
 ```ts
@@ -1331,6 +1348,7 @@ For accessing the authenticated AuthUser model reference, you can inject the CUR
 
 ### Instagram Oauth 2
 
+In order to use it, run `npm install passport-instagram`.
 First, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.
 
 ```ts
@@ -1642,6 +1660,7 @@ For accessing the authenticated AuthUser model reference, you can inject the CUR
 
 ### Apple Oauth 2
 
+In order to use it, run `npm install --save passport-apple`.
 First, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.
 
 ```ts
@@ -1955,6 +1974,7 @@ For accessing the authenticated AuthUser model reference, you can inject the CUR
 
 ### Facebook Oauth 2
 
+In order to use it, run `npm install passport-facebook`.
 First, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.
 
 ```ts
@@ -2266,6 +2286,7 @@ For accessing the authenticated AuthUser model reference, you can inject the CUR
 
 ### Keycloak
 
+In order to use it, run `npm install @exlinc/keycloak-passport`.
 First, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.
 
 ```ts
@@ -2608,6 +2629,7 @@ this.bind(VerifyBindings.BEARER_SIGNUP_VERIFY_PROVIDER).toProvider(
 
 ### SAML
 
+In order to use it, run `npm install @node-saml/passport-saml`.
 SAML (Security Assertion Markup Language) is an XML-based standard for exchanging authentication and authorization data between parties, in particular, between an identity provider (IdP) and a service provider (SP).
 
 First, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.