{"_id":"@salla.sa/passport-strategy","_rev":"184-8ef3a80d32113bd2432641edc62d0b42","name":"@salla.sa/passport-strategy","dist-tags":{"latest":"1.0.6"},"versions":{"1.0.2":{"name":"@salla.sa/passport-strategy","version":"1.0.2","keywords":["node","passport","salla"],"author":{"url":"https://github.com/SallaApp","name":"Salla App"},"license":"MIT","_id":"@salla.sa/passport-strategy@1.0.2","maintainers":[{"name":"s.alkhwlani","email":"yemenifree@yandex.com"}],"homepage":"https://github.com/SallaApp/passport-salla#readme","bugs":{"url":"https://github.com/SallaApp/passport-salla/issues"},"dist":{"shasum":"d734f38f163d7246c91e027d62ec3cf2deff0fb2","tarball":"https://registry.npmjs.org/@salla.sa/passport-strategy/-/passport-strategy-1.0.2.tgz","fileCount":19,"integrity":"sha512-0++gFkBc3TYuiMIIKEZS8YM8vqhQSY5KLv+IkqE3bkRyijOQ2iYTNZAMKha5WNC34l0m6b5Y0efGvBHuU2OTUQ==","signatures":[{"sig":"MEQCICj6aK47LnvNIQBQiSZAoskWTFMBsu834poi+Ozk1WrtAiBjGxKQFBvy6xUu+TQbDkvZKl8cGZhjdXw2tTxY7zKuHw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":69307,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhk7/7CRA9TVsSAnZWagAAbvUP/jp2iwKMsqsSLiEOByqd\nFcqECaGb7/ewkbr3k1Cl0wmIciSwqniI2RNRRPsOlmxHv0r7oHNHdFVDmGe8\nl0yBdTvuC/ELvkSAShWOJA0902zOYTiqD2xGDu6p6h4zmIwox2jGGymE1PRm\nnnj0NMNZ9c2xEBHeBX+vDQ2W811U61vS9QTqEeQAYDvskKRCnkyeKMgkoGcD\n//dr6uMqL2Br8DjUZZzUapg/APiqMIOy24mBFyiAXfkypBkYBcZXEeQxW1Ha\nFXCxSnsoq+IWfnmadlWiAZQEW8/yzXyolOOYi4MK9ze8TZviPvYYjZrosajJ\nvFKiMfTStk3vVezuI1/bo8fRGCHugTFrD3NRajN9AtbTWxe/POUySL968UKf\nEKG2hIziLKZDCp+d6o5b15EUh2BTk/sHMVAiA5FQ6Oeb6aNi7aSsJ1Fa8M0l\naFlITnjYG+jy3BtmyO7mAByOnSWbEhOGNPKrFKfGq+LLsJeH23pxgaCjIWNc\neU2Saz5IERdVfxjoWpNx4OkwzAuRl34HHQ9E32H+RTMVK0sbHfsvqSiUIh3L\nJeVy1I4X4WfLzW3R8/ynsn4e+ZrU+9W+0ZkT0o8png2sAnE06Hq5JGQ+H6/q\ncrGE/MMb5OvMuuoHNMbTiTVI7ySh9QD0SvT3UbzYggJozaXwsviL1O8MT8uj\nlS50\r\n=8kcH\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./src/init.js","gitHead":"3c7ff5a2c0a9b90403af1c11573161cbdd361cf9","scripts":{"test":"mocha"},"_npmUser":{"name":"s.alkhwlani","email":"yemenifree@yandex.com"},"repository":{"url":"git+https://github.com/SallaApp/passport-salla.git","type":"git"},"_npmVersion":"6.14.15","description":"Salla authentication strategy for Passport.","directories":{"test":"test","example":"example"},"_nodeVersion":"14.18.1","dependencies":{"util":"~0.12.0","querystring":"~0.2.0","passport-oauth":"1.0.0","passport-oauth2-refresh":"^2.1.0"},"_hasShrinkwrap":false,"devDependencies":{"mocha":"^8.2.1","sinon":"7.4.2","should":"13.2.3"},"_npmOperationalInternal":{"tmp":"tmp/passport-strategy_1.0.2_1637072891726_0.3007269370078858","host":"s3://npm-registry-packages"}},"1.0.3":{"name":"@salla.sa/passport-strategy","version":"1.0.3","keywords":["node","passport","salla"],"author":{"url":"https://github.com/SallaApp","name":"Salla App"},"license":"MIT","_id":"@salla.sa/passport-strategy@1.0.3","maintainers":[{"name":"rashaamer","email":"Ralamer87@gmail.com"},{"name":"egkrinkel","email":"ahmed@salla.sa"},{"name":"eslamoo","email":"essomgd@gmail.com"},{"name":"adelgs","email":"adel@salla.sa"},{"name":"asmaa_sh_ali","email":"asm_sh_a@hotmail.com"},{"name":"dhafer","email":"dhafer@salla.sa"},{"name":"anasred","email":"anasahmar@gmail.com"},{"name":"omaralalwisalla","email":"omar.alalwi@salla.sa"},{"name":"devlomingo","email":"mo7md.badr@gmail.com"},{"name":"yamenarahman","email":"yamen.a.abdulrahman@hotmail.com"},{"name":"ossycodes","email":"ossyfizy009@gmail.com"},{"name":"salahmyn","email":"salahmyn@gmail.com"},{"name":"anass_at","email":"anass@salla.sa"},{"name":"adilah.m","email":"adilah.m@salla.sa"},{"name":"adel.elshafey","email":"adel.elshafey@salla.sa"},{"name":"tahaabdoh","email":"taha.abdoh@gmail.com"},{"name":"jamalla","email":"jamalla@salla.sa"},{"name":"krinkel","email":"admin@yallagroup.net"},{"name":"jalmatari","email":"jalmatari@gmail.com"},{"name":"ashraf.reda","email":"ashraf@salla.sa"},{"name":"s.alkhwlani","email":"yemenifree@yandex.com"}],"homepage":"https://github.com/SallaApp/passport-salla#readme","bugs":{"url":"https://github.com/SallaApp/passport-salla/issues"},"dist":{"shasum":"fc2df488b9170f80e367fb051b9a91ff6d3fe6f3","tarball":"https://registry.npmjs.org/@salla.sa/passport-strategy/-/passport-strategy-1.0.3.tgz","fileCount":19,"integrity":"sha512-0FIBr75VSaFdVjbA463HsxG/6Sd6nttIpwPnhBAld9L3rLjT8TfnEkAH85rFaSLo8gtIPw0VcBUGU8SKCFL4hA==","signatures":[{"sig":"MEYCIQDFTvbODkSiDl9YZ5UeCIVae1cF4TJykIyA8L/V9Buu4wIhANk/YRkoIc4RDHvQaiGAGld8BpSoBsK4owct3FzdjlZ+","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":67639,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhn+4gCRA9TVsSAnZWagAA8GUP/iVkO25kyH1qahB+52S0\n02rzJz/XwvcsJ81Kl3kNJavXK3jbQnv8Bp/CpZWFIykaKpZzhqSNsb2pqxzm\ncpqaAmHM+4szpaJzRurGzhLd0i4T3y/69uwUvUgETW0ApIA29d1vDVXum2g2\n3TuG7pjNFwxNCXxOEB7vatinNNp+09TBGRIw+blDjPDT0Mcm7bowiet8AL7j\noFHu5XVyX0goQZP++ssXgtE+VF+e+Ha/Xm2yV8ZTzRopX9lMQvdX6eIb7k+R\nAxRBW1mqcKjqWbUABVvVzIg75JJMu8KTQOXTLhOIDZD7MJeLQD7M/jPEP1vy\nU1gmVmoStT9OczVfIPtbdTuSb9Oixx1EWMaBhW5hGjx3L5Q7ec95ij3hn0hC\nqjubYRFE1vopW8f7VvloP3CbpSAB8EsrTzK68qRDrZ844kjYWS2mH5OckFX0\nTIr+jT+Uz9ARTbTjcmqG1w0arE7/CNwJ3yksCmHAPWHHtJTKoSf38VLCkIE5\nOVTySr21k3hyasWS6gm6MQq+txlK4mAS4hVvhhwYR2BHBwWo9YQNrizgbZ7S\nSZ6lTiFDZX0XiQhFUpUsklZ1zjDHLcY26r+1f1V95jXiy2CBRNc0Yr8jKhwy\nKoQ/bBr7cdMis2lTfk4XhET8olzjArmA3wV+wU3JeUoFc9yjznC5mwGO+o/s\neHgS\r\n=bwoj\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./src/init.js","gitHead":"a91a6d719fc86fb2c4f04d7607a58f8dbbc9f611","scripts":{"test":"mocha"},"_npmUser":{"name":"s.alkhwlani","email":"yemenifree@yandex.com"},"repository":{"url":"git+https://github.com/SallaApp/passport-salla.git","type":"git"},"_npmVersion":"6.14.15","description":"Salla authentication strategy for Passport.","directories":{"test":"test","example":"example"},"_nodeVersion":"14.18.1","dependencies":{"util":"~0.12.0","querystring":"~0.2.0","passport-oauth":"1.0.0","passport-oauth2-refresh":"^2.1.0"},"_hasShrinkwrap":false,"devDependencies":{"mocha":"^8.2.1","sinon":"7.4.2","should":"13.2.3"},"_npmOperationalInternal":{"tmp":"tmp/passport-strategy_1.0.3_1637871136146_0.9136455443925413","host":"s3://npm-registry-packages"}},"1.0.6":{"name":"@salla.sa/passport-strategy","version":"1.0.6","keywords":["node","passport","salla"],"author":{"url":"https://github.com/SallaApp","name":"Salla App"},"license":"MIT","_id":"@salla.sa/passport-strategy@1.0.6","maintainers":[{"name":"rashaamer","email":"Ralamer87@gmail.com"},{"name":"egkrinkel","email":"ahmed@salla.sa"},{"name":"eslamoo","email":"essomgd@gmail.com"},{"name":"adelgs","email":"adel@salla.sa"},{"name":"asmaa_sh_ali","email":"asm_sh_a@hotmail.com"},{"name":"dhafer","email":"dhafer@salla.sa"},{"name":"anasred","email":"anasahmar@gmail.com"},{"name":"omaralalwisalla","email":"omar.alalwi@salla.sa"},{"name":"devlomingo","email":"mo7md.badr@gmail.com"},{"name":"yamenarahman","email":"yamen.a.abdulrahman@hotmail.com"},{"name":"ossycodes","email":"ossyfizy009@gmail.com"},{"name":"salahmyn","email":"salahmyn@gmail.com"},{"name":"anass_at","email":"anass@salla.sa"},{"name":"adilah.m","email":"adilah.m@salla.sa"},{"name":"adel.elshafey","email":"adel.elshafey@salla.sa"},{"name":"tahaabdoh","email":"taha.abdoh@gmail.com"},{"name":"jamalla","email":"jamalla@salla.sa"},{"name":"krinkel","email":"admin@yallagroup.net"},{"name":"jalmatari","email":"jalmatari@gmail.com"},{"name":"ashraf.reda","email":"ashraf@salla.sa"},{"name":"s.alkhwlani","email":"yemenifree@yandex.com"}],"homepage":"https://github.com/SallaApp/passport-salla#readme","bugs":{"url":"https://github.com/SallaApp/passport-salla/issues"},"dist":{"shasum":"5a26a25adaba8626694e4ce27b0fafe47ed5b334","tarball":"https://registry.npmjs.org/@salla.sa/passport-strategy/-/passport-strategy-1.0.6.tgz","fileCount":19,"integrity":"sha512-ufe+OacMxdy9VyUHMz1VjCiMANt4iZnRtHsmXqFxa33K1tgpMQOm39zB+5jo26mmldcPTEvsuR6CtckK9L2SsA==","signatures":[{"sig":"MEUCIQDagwOsTFfeoL/fJaBg7uLgQwjjCcPxcqbDlI4EjIHWRAIgFHH09B7BJcmXIvePYWG+rHp9TNp4ujuT3zS6rD06+P0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":67639,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhn+6GCRA9TVsSAnZWagAAN7gQAIjBzIeejWbSMd1ZL/eW\nizxFpMqLeexQ0RjkP/L79mUYvNjgSAm+MbidwnVc2oODnUMUDGHX13cQTqeS\nk7nSGvW6R3OyO8N2eFjp475JMuvWsZOcQqAA8ag55HzDqGCB2cQbfQbAx1qB\n3pFWwkEtC73fkB8+9PxDzpRjDjcIBmN7eZjMik7ldsQq7hS1QQFEDUqihMPI\nvCWQboo4K5XMQ32ng91RY+RDZAAUd7tONI2w+OIc8jw2u94q688kh3Q1875z\nGpETel+8yp3N+gmq2YwN9aDyhWTxudseFY2VzUlU5VNNbXTQKmtgH8bKVyFs\nW5TRsdbiOKoj7+7mv3dh3QftKsRfj7ONM5ynRX8liNm4OYLui8qNkq97omzn\n4a/E62YkmIgwQjpk2dCJwAYl78Vbw3TNevJ9OefYmkKxGL6F2LWEJp0YgwGA\nvwu9sYBTIL803GZjbwk9YEyZJ46Wq9P830wnXkH/R1Ips8QKNfKcCsjl3xIG\nUqlb5gnLDGbL1ssWuxbCi15Yw/+SnkF/1zIYocwpCq+PBGGXlDlJ1FUMGpG7\nXUulohKypBbsSelW5Edhabs6fSyYzRIWCUFBzvdEgdH0Axd/IpgpUKzBPa4Q\nb/AYX9TRje3C7EBcmLDBseOTEZ5kgHlpIz/Z8TQSymzukg/kXWMkkPiwmAUt\nK0Xx\r\n=pX+z\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./src/init.js","gitHead":"37f5879cf624bdf09a05a393baaca08c6135fc78","scripts":{"test":"mocha"},"_npmUser":{"name":"s.alkhwlani","email":"yemenifree@yandex.com"},"repository":{"url":"git+https://github.com/SallaApp/passport-salla.git","type":"git"},"_npmVersion":"6.14.15","description":"Salla authentication strategy for Passport.","directories":{"test":"test","example":"example"},"_nodeVersion":"14.18.1","dependencies":{"util":"~0.12.0","querystring":"~0.2.0","passport-oauth":"1.0.0","passport-oauth2-refresh":"^2.1.0"},"_hasShrinkwrap":false,"devDependencies":{"mocha":"^8.2.1","sinon":"7.4.2","should":"13.2.3"},"_npmOperationalInternal":{"tmp":"tmp/passport-strategy_1.0.6_1637871237836_0.8080121781215013","host":"s3://npm-registry-packages"}}},"time":{"created":"2021-11-16T14:28:11.684Z","modified":"2026-07-28T17:55:26.743Z","1.0.0":"2021-11-16T14:25:29.408Z","1.0.1":"2021-11-16T14:25:29.408Z","1.0.2":"2021-11-16T14:28:11.890Z","1.0.3":"2021-11-25T20:12:16.314Z","1.0.6":"2021-11-25T20:13:58.002Z"},"bugs":{"url":"https://github.com/SallaApp/passport-salla/issues"},"author":{"url":"https://github.com/SallaApp","name":"Salla App"},"license":"MIT","homepage":"https://github.com/SallaApp/passport-salla#readme","keywords":["node","passport","salla"],"repository":{"url":"git+https://github.com/SallaApp/passport-salla.git","type":"git"},"description":"Salla authentication strategy for Passport.","maintainers":[{"email":"yemenifree@yandex.com","name":"s.alkhwlani"},{"email":"jalmatari@gmail.com","name":"jalmatari"},{"email":"info@salla.dev","name":"salla.dev"},{"email":"here.abran@gmail.com","name":"hereabran"}],"readme":"
\n
\n \n \"Logo\"\n \n\n

Salla OAuth 2.0 - Passport Strategy

\n

\n Passport strategy is used with Salla as an authentication middleware module\nusing the OAuth 2.0 API.\n
\n Explore our blogs »\n
\n
Report Bug · Request Feature\n

\n
\n\n# Overview\n\nThis module enables you to implement the authentication process using Salla within your Nodejs applications.\nBy plugging it into Passport, Salla authentication can be quickly and unobtrusively implemented into any application\nor framework that supports [connect-style](http://www.senchalabs.org/connect) middleware, including [Express.js](http://expressjs.com), by plugging it into Passport.\n\nFor more information about Salla's OAuth 2.0 implementation, check our\n[Web API Authorization Guide](https://salla.dev/blog/oauth-2-0-in-action-with-salla).\n\n## OAuth Workflow\n\n![OAuth Workflow](https://i.ibb.co/xLyn80t/Frame-1236-OAuth-5.png)\n\n## Installation\n\n $ npm install @salla.sa/passport-strategy\n\n

(back to top)

\n\n## Usage\n\n### Configure Strategy\n\nSalla authentication strategy authenticates users using a Salla Merchant Account\nand OAuth 2.0 tokens. This strategy requires a `verify` callback, which accepts\nthese credentials and calls `done` providing a user as well as `options`\nspecifying a client ID, client secret, and callback URL.\n\n```javascript\nconst express = require(\"express\");\nconst passport = require(\"passport\");\nconst SallaAPIFactory = require(\"@salla.sa/passport-strategy\");\nconst app = express();\n\nconst port = 8081;\n\n// we initialize our Salla API\nconst SallaAPI = new SallaAPIFactory({\n clientID: \"CLIENT_ID\", // The client ID assigned to you by Salla in Salla Partner Portal\n clientSecret: \"CLIENT_SECRET\", // The client password assigned to you by Salla in Salla Partner Portal\n callbackURL: \"http://localhost:8081/oauth/callback\", // the /oauth/callback in your service\n});\n\n// Use the Salla Strategy within Passport.\npassport.use(SallaAPI.getPassportStrategy());\n\n// save token and user data to your selected database\nSallaAPI.onAuth((accessToken, refreshToken, expires_in, user) => {\n /*\n accessToken\n refreshToken \n expires_in\n user\n */\n});\n\n/*\n when your user login to your application you can retrieve the access token and use\n it to access the Salla APIs from SallaAPI.setAccessToken .\n \n SallaAPI.setAccessToken(\n ACCESS_TOKEN_FROM_DATABASE,\n REFRESH_TOKEN_FROM_DATABASE,\n EXPIRES_IN_FROM_DATABASE,\n USER_PROFILE_FROM_DATABASE\n );\n\n*/\n\n// we set salla express middleware\napp.use((req, res, next) => SallaAPI.setExpressVerify(req, res, next));\n\n// GET /\n// render the index page\n\napp.get(\"/\", function (req, res) {\n res.send({ user: req.user });\n});\n\n// GET /oauth/redirect\n// Use passport.authenticate() as route middleware to authenticate the\n// request. The first step in salla authentication will involve redirecting\n// the user to accounts.salla.sa. After authorization, salla will redirect the user\n// back to this application at /oauth/callback\napp.get(\"/oauth/redirect\", passport.authenticate(\"salla\"));\n\n// GET /oauth/callback\n// Use passport.authenticate() as route middleware to authenticate the\n// request. If authentication fails, the user will be redirected back to the\n// login page. Otherwise, the primary route function function will be called,\n// which, in this example, will redirect the user to the home page.\napp.get(\n \"/oauth/callback\",\n passport.authenticate(\"salla\", { failureRedirect: \"/login\" }),\n function (req, res) {\n res.redirect(\"/\");\n }\n);\n\napp.listen(port, function () {\n console.log(\"App is listening on port \" + port);\n});\n```\n\n

(back to top)

\n\n## Refreshing a Token\n\nRefresh tokens can be received by calling SallaAPI.refreshToken() function, which returns a Promies.\n\n```javascript\nconst SallaAPI = require(\"@salla.sa/passport-strategy\");\n\nSallaAPI.requestNewAccessToken(SallaAPI.getRefreshToken())\n .then(({ accessToken, newRefreshToken }) => {\n // save new access token and refresh token to your database\n })\n .catch((err) => res.send(err));\n```\n\n## Examples\n\nFor a complete, working example, refer to the [login example](#Examples), you can get your keys on [Salla Partners > My Applications](https://salla.partners]).\n\nGetting All Orders from the store\n\n```javascript\napp.get(\"/orders\", ensureAuthenticated, async function (req, res) {\n res.render(\"orders.html\", {\n orders: await SallaAPI.getAllOrders(),\n });\n});\n```\n\nFetching Resources dynamic url\n\n```javascript\napp.get(\"/customers\", ensureAuthenticated, async function (req, res) {\n res.render(\"orders.html\", {\n customers: await SallaAPI.fetchResource({\n url: \"https://api.salla.dev/admin/v2/customers\",\n }),\n });\n});\n```\n\n

(back to top)

\n\n## Tests\n\n $ npm install --dev\n $ npm test\n\n

(back to top)

\n\n## Contributing\n\nContributions are what make the open-source community such an amazing place to learn, inspire, and create.\nAny contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request.\nYou can also simply open an issue with the tag \"enhancement\". Don't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n

(back to top)

\n\n## Security\n\nIf you discover any securitys-related issues, please email security@salla.sa instead of using the issue tracker.\n\n## Credits\n\n- [Salla](https://github.com/sallaApp)\n- [All Contributors](../../contributors)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n\n

(back to top)

\n","readmeFilename":"README.md"}