{"_id":"@bzsklvnt/remix-auth-linkedin","_rev":"1-00d165d44be28ca55b2e549175cbe8fd","name":"@bzsklvnt/remix-auth-linkedin","dist-tags":{"latest":"2.0.0"},"versions":{"1.0.1":{"name":"@bzsklvnt/remix-auth-linkedin","version":"1.0.1","main":"./build/index.js","types":"./build/index.d.ts","scripts":{"build":"tsc --project tsconfig.json","typecheck":"tsc --project tsconfig.json --noEmit","lint":"eslint --ext .ts,.tsx src/","test":"jest --config=config/jest.config.ts --passWithNoTests","coverage":"npm run test -- --coverage"},"keywords":["remix","remix-auth","auth","authentication","strategy","oauth2","oauth2-linkedin","remix-auth-linkedin"],"author":{"name":"Levente Bozsoki","email":"levbozsoki@gmail.com","url":"https://github.com/bzsklvnt"},"repository":{"url":"git+https://github.com/bzsklvnt/remix-auth-linkedin.git","type":"git"},"license":"MIT","peerDependencies":{"@remix-run/server-runtime":"^2.0.1"},"devDependencies":{"@babel/core":"^7.22.17","@babel/preset-env":"^7.22.15","@babel/preset-react":"^7.22.15","@babel/preset-typescript":"^7.22.15","@remix-run/node":"^2.0.1","@remix-run/react":"^2.0.1","@remix-run/server-runtime":"^2.0.1","@types/jest":"^29.5.4","@typescript-eslint/eslint-plugin":"^6.7.0","@typescript-eslint/parser":"^6.7.0","babel-jest":"^29.7.0","eslint":"^8.49.0","eslint-config-prettier":"^9.0.0","eslint-plugin-jest":"^27.2.3","eslint-plugin-jest-dom":"^5.1.0","eslint-plugin-prettier":"^5.0.0","eslint-plugin-unicorn":"^48.0.1","jest":"^29.7.0","jest-fetch-mock":"^3.0.3","prettier":"^3.0.3","react":"^18.2.0","ts-node":"^10.9.1","typescript":"^5.2.2"},"dependencies":{"remix-auth":"^3.2.1","remix-auth-oauth2":"^1.9.0"},"_id":"@bzsklvnt/remix-auth-linkedin@1.0.1","gitHead":"52b2ebba5c4b71432796ff3f90fcdf01b1325505","description":"The Linkedin strategy is used to authenticate users against a Linkedin account. It extends the [OAuth2Strategy](https://github.com/sergiodxa/remix-auth-oauth2).","bugs":{"url":"https://github.com/bzsklvnt/remix-auth-linkedin/issues"},"homepage":"https://github.com/bzsklvnt/remix-auth-linkedin#readme","_nodeVersion":"20.9.0","_npmVersion":"10.1.0","dist":{"integrity":"sha512-NOCgKY7IiufC5YV3a4P/akfgYcUDqMHJPwLBo2xWeVVZjBxO3hZEvNtVV/160nl+hfF1VtWl1xHNLpTaf6+zbg==","shasum":"5e34eef31789cccfa61756c1f9ff13660625c99a","tarball":"https://registry.npmjs.org/@bzsklvnt/remix-auth-linkedin/-/remix-auth-linkedin-1.0.1.tgz","fileCount":5,"unpackedSize":14514,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCtfZaVcZNdGts/5bZmGT/IC+7GNasWXanbd9tlfgJpYgIhANVUAFlbIdU1obmNP3einEitd3sadDeQRzII0ieSW9mm"}]},"_npmUser":{"name":"bzsklvnt","email":"levbozsoki@gmail.com"},"directories":{},"maintainers":[{"name":"bzsklvnt","email":"levbozsoki@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remix-auth-linkedin_1.0.1_1699948477313_0.652217261908927"},"_hasShrinkwrap":false},"2.0.0":{"name":"@bzsklvnt/remix-auth-linkedin","version":"2.0.0","main":"./build/index.js","types":"./build/index.d.ts","scripts":{"build":"tsc --project tsconfig.json","typecheck":"tsc --project tsconfig.json --noEmit","lint":"eslint --ext .ts,.tsx src/","test":"jest --config=config/jest.config.ts --passWithNoTests","coverage":"npm run test -- --coverage"},"keywords":["remix","remix-auth","auth","authentication","strategy","oauth2","oauth2-linkedin","remix-auth-linkedin"],"author":{"name":"Levente Bozsoki","email":"levbozsoki@gmail.com","url":"https://github.com/bzsklvnt"},"repository":{"url":"git+https://github.com/bzsklvnt/remix-auth-linkedin.git","type":"git"},"license":"MIT","peerDependencies":{"@remix-run/server-runtime":"^2.0.1"},"devDependencies":{"@babel/core":"^7.22.17","@babel/preset-env":"^7.22.15","@babel/preset-react":"^7.22.15","@babel/preset-typescript":"^7.22.15","@remix-run/node":"^2.0.1","@remix-run/react":"^2.0.1","@remix-run/server-runtime":"^2.0.1","@types/jest":"^29.5.4","@typescript-eslint/eslint-plugin":"^6.7.0","@typescript-eslint/parser":"^6.7.0","babel-jest":"^29.7.0","eslint":"^8.49.0","eslint-config-prettier":"^9.0.0","eslint-plugin-jest":"^27.2.3","eslint-plugin-jest-dom":"^5.1.0","eslint-plugin-prettier":"^5.0.0","eslint-plugin-unicorn":"^48.0.1","jest":"^29.7.0","jest-fetch-mock":"^3.0.3","prettier":"^3.0.3","react":"^18.2.0","ts-node":"^10.9.1","typescript":"^5.2.2"},"dependencies":{"remix-auth":"^3.2.1","remix-auth-oauth2":"^1.9.0"},"_id":"@bzsklvnt/remix-auth-linkedin@2.0.0","gitHead":"52b2ebba5c4b71432796ff3f90fcdf01b1325505","description":"The Linkedin strategy is used to authenticate users against a Linkedin account. It extends the [OAuth2Strategy](https://github.com/sergiodxa/remix-auth-oauth2).","bugs":{"url":"https://github.com/bzsklvnt/remix-auth-linkedin/issues"},"homepage":"https://github.com/bzsklvnt/remix-auth-linkedin#readme","_nodeVersion":"20.9.0","_npmVersion":"10.1.0","dist":{"integrity":"sha512-BSYtvtGO4ZM2fDhFF/FGmB5SWhE38T6VedZnxrS1xzEP1NR4i0ANN1RrkSB5DcTtRQJ70kftwHGvKlbR0EJdtA==","shasum":"3eb2b12d62cca8eda30e79ca581641d40ef586d6","tarball":"https://registry.npmjs.org/@bzsklvnt/remix-auth-linkedin/-/remix-auth-linkedin-2.0.0.tgz","fileCount":5,"unpackedSize":14514,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAmeWrR/ZmagHSOBMC3YKc/taLlnyMR9g8biYK6K3uRFAiEA2KWrtmtV9iKy56jdJPh7I/adX1cesxXsw2BIs8Llgbo="}]},"_npmUser":{"name":"bzsklvnt","email":"levbozsoki@gmail.com"},"directories":{},"maintainers":[{"name":"bzsklvnt","email":"levbozsoki@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remix-auth-linkedin_2.0.0_1699948498712_0.9327576419443415"},"_hasShrinkwrap":false}},"time":{"created":"2023-11-14T07:54:37.201Z","1.0.1":"2023-11-14T07:54:37.481Z","modified":"2023-11-14T07:54:59.095Z","2.0.0":"2023-11-14T07:54:58.905Z"},"maintainers":[{"name":"bzsklvnt","email":"levbozsoki@gmail.com"}],"description":"The Linkedin strategy is used to authenticate users against a Linkedin account. It extends the [OAuth2Strategy](https://github.com/sergiodxa/remix-auth-oauth2).","homepage":"https://github.com/bzsklvnt/remix-auth-linkedin#readme","keywords":["remix","remix-auth","auth","authentication","strategy","oauth2","oauth2-linkedin","remix-auth-linkedin"],"repository":{"url":"git+https://github.com/bzsklvnt/remix-auth-linkedin.git","type":"git"},"author":{"name":"Levente Bozsoki","email":"levbozsoki@gmail.com","url":"https://github.com/bzsklvnt"},"bugs":{"url":"https://github.com/bzsklvnt/remix-auth-linkedin/issues"},"license":"MIT","readme":"# LinkedinStrategy\n\nThe Linkedin strategy is used to authenticate users against a Linkedin account. It extends the [OAuth2Strategy](https://github.com/sergiodxa/remix-auth-oauth2).\n\n## Attribution and Acknowledgments\nThis project is a fork of [remix-auth-linkedin](https://github.com/Lzok/remix-auth-linkedin) by [juhanakristian](https://github.com/Lzok). We are immensely grateful to the original authors for their hard work and dedication in creating a foundation that has inspired our version. Our modifications and extensions are built upon the robust groundwork they established.\n\nFor details about the original project and its features, please visit the Original Repository.\n\nWe aim to respect the original vision while also adding our unique contributions, which are documented in our changelog and release notes. Our project follows the licensing terms set forth in the original, adhering to the principles of open-source collaboration and mutual respect for the creators' efforts.\n\nWe encourage users and contributors to also explore the original repository to understand the origins of this project and appreciate the collective effort involved in its ongoing development.\n\nIn this version we aimed to make changes, so that this project is compatible with @remix-run/server-runtime v2 >.\n\n## Supported runtimes\n\n| Runtime    | Has Support |\n| ---------- | ----------- |\n| Node.js    | ✅          |\n| Cloudflare | ✅          |\n\n\n## Usage\n\n### Create an OAuth application\n\nFirst you need to create a new application in the [Linkedin's developers page](https://developer.linkedin.com/). Then I encourage you to read [this documentation page](https://learn.microsoft.com/en-us/linkedin/consumer/integrations/self-serve/sign-in-with-linkedin-v2), it explains how to configure your app and gives you useful information on the auth flow.\nThe app is mandatory in order to obtain a `clientID` and `client secret` to use with the Linkedin's API.\n\n### Create the strategy instance\n\n```ts\n// linkedin.server.ts\nimport { createCookieSessionStorage } from 'remix';\nimport { Authenticator } from 'remix-auth';\nimport { LinkedinStrategy } from \"remix-auth-linkedin\";\n\n// Personalize this options for your usage.\nconst cookieOptions = {\n\tpath: '/',\n\thttpOnly: true,\n\tsameSite: 'lax' as const,\n\tmaxAge: 24 * 60 * 60 * 1000 * 30,\n\tsecrets: ['THISSHOULDBESECRET_AND_NOT_SHARED'],\n\tsecure: process.env.NODE_ENV !== 'development',\n};\n\nconst sessionStorage = createCookieSessionStorage({\n\tcookie: cookieOptions,\n});\n\nexport const authenticator = new Authenticator<string>(sessionStorage, {\n\tthrowOnError: true,\n});\n\nconst linkedinStrategy = new LinkedinStrategy(\n   {\n      clientID: \"YOUR_CLIENT_ID\",\n      clientSecret: \"YOUR_CLIENT_SECRET\",\n      // LinkedIn is expecting a full URL here, not a relative path\n      // see: https://learn.microsoft.com/en-us/linkedin/shared/authentication/authorization-code-flow?tabs=HTTPS1#step-1-configure-your-application\n      callbackURL: \"https://example.com/auth/linkedin/callback\";\n   },\n   async ({accessToken, refreshToken, extraParams, profile, context}) => {\n      /*\n         profile:\n         type LinkedinProfile = {\n            id: string;\n            displayName: string;\n            name: {\n               givenName: string;\n               familyName: string;\n            };\n            emails: Array<{ value: string }>;\n            photos: Array<{ value: string }>;\n            _json: LiteProfileData & EmailData;\n         } & OAuth2Profile;\n      */\n\n      // Get the user data from your DB or API using the tokens and profile\n      return User.findOrCreate({ email: profile.emails[0].value });\n   }\n);\n\nauthenticator.use(linkedinStrategy, 'linkedin');\n```\n\n### Setup your routes\n\n```tsx\n// app/routes/login.tsx\nexport default function Login() {\n   return (\n      <Form action=\"/auth/linkedin\" method=\"post\">\n         <button>Login with Linkedin</button>\n      </Form>\n   )\n}\n```\n\n```tsx\n// app/routes/auth/linkedin.tsx\nimport { ActionFunction, LoaderFunction } from 'remix'\nimport { authenticator } from '~/linkedin.server'\n\nexport let loader: LoaderFunction = () => redirect('/login')\nexport let action: ActionFunction = ({ request }) => {\n   return authenticator.authenticate('linkedin', request)\n}\n```\n\n```tsx\n// app/routes/auth/linkedin/callback.tsx\nimport { ActionFunction, LoaderFunction } from 'remix'\nimport { authenticator } from '~/linkedin.server'\n\nexport let loader: LoaderFunction = ({ request }) => {\n   return authenticator.authenticate('linkedin', request, {\n      successRedirect: '/dashboard',\n      failureRedirect: '/login',\n   })\n}\n```\n","readmeFilename":"README.md"}