@idio/linkedin


@idio/linkedin is The LinkedIn OAuth Login Routes For The Idio Web Server.

``sh
yarn add -E @idio/linkedin
`

Table Of Contents

- Table Of Contents
- API
- linkedin(router: Router, config: Config)
* Config
* finish
* error
- getUser(user: *): User
* User
- async query(config: QueryConfig): *
* QueryConfig
- linkedInButton(): { idioCommon, style, button }
- Copyright

API

The package is available by importing its default and named functions:

`js
import linkedin, {
linkedInButton, query, getUser,
} from '@idio/linkedin'
`

linkedin(
  router: Router,
  config: Config,
): void

Sets up the /auth/linkedin and /auth/linkedin/redirect paths on the router to enable LinkedIn App Login. The session middleware needs to be installed to remember the state. The state is destroyed after the redirect.

__Config__: Options for the program.

| Name | Type | Description | Default |
| ------------------ | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------- |
| __client_id*__ | _string_ | The app's client id. | - |
| __client_secret*__ | _string_ | The app's client secret. | - |
| path | _string_ | The server path to start the login flaw and use for redirect (${path}/redirect). | /auth/linkedin |
| scope | _string_ | The scope to ask permissions for. | r_liteprofile |
| finish | _(ctx, token, user) => {}_ | The function to complete the authentication that receives the token and the data about the user, such as name and id. The default function redirects to /. | setSession; redirect; |
| error | _(ctx, error, error_description, next) => {}_ | The function to be called in case of error. If not specified, the middleware will throw an internal server error. | throw; |
| session | _Middleware_ | The configured session middleware in case the session property is not globally available on the context. | - |

`js
import linkedIn, { query, linkedInButton, getUser } from '@idio/linkedin'
import idioCore from '@idio/core'

const Server = async () => {
const { url, router, app, middleware: {
session,
} } = await idioCore({
session: {
keys: [process.env.SESSION_KEY],
},
logger: { use: true },
}, { port: 0 })
router.get('/', async (ctx) => {
const u = await userDiv(ctx.session.user)
ctx.body =


${u}

const userDiv = async (user) => {
if (!user) {
const { idioCommon, style, button } = await linkedInButton()
return

> Redirect to Dialog https://www.linkedin.com/oauth/v2/authorization?state=7739&response_type=code&client_id=86986rqg6dmn58&redirect_uri=http%3A%2F%2Flocalhost%3A65210%2Fauth%2Flinkedin%2Fredirect&scope=r_liteprofile%2Cr_basicprofile
`

$3

The config allows to set the finish function that can be used to alter the logic of setting the token on the session or performing additional operations such as storing a new user in the database. The default sets the token on the ctx.session and also sets the user data such as name and id in the ctx.session.user property.

$3

The error property of the config represent the function to be called in case of an error such as when the user cancelled the authorisation request. It can be used to redirect to the path and set the error text and description in the query parameters. When default handler is used, the @idio/linkedin middleware will throw internally.

getUser(
  user: *,
): User

When data is requested from /me route for the lite profile, the results will come back containing a lot of metadata such as names' locales and an array with profile pictures of different sizes. The getUser method returns those properties as strings.

__User__: The normalised user data from the /me path.

| Name | Type | Description |
| ------------------- | -------- | ------------------------------- |
| __id*__ | _string_ | The user ID. |
| __firstName*__ | _string_ | The user's first name. |
| __lastName*__ | _string_ | The user's last name. |
| __profilePicture*__ | _string_ | The URL to the profile picture. |

async query(
  config: QueryConfig,
): *

The query method allows to query the LinkedIn API. The v2 version of the API only allows to query basic data with the r_liteprofile permission. The other methods of the API are not pubic. This package will automatically query the /me route to find out the user's name and profile picture, therefore specifying the r_liteprofile scope is required. The v1 version which is used to query positions with the r_basicprofile scope will be switched off in March 2019.

__QueryConfig__: Options for Query.

| Name | Type | Description | Default |
| ---------- | -------- | ------------------------------------------------- | ------- |
| __token*__ | _string_ | The access token with appropriate permissions. | - |
| __path*__ | _string_ | The API endpoint. | - |
| __data__ | __ | The object containing data to query the API with. | - |
| version | _string_ | The version of the API to query. | v2 |

linkedInButton(): { idioCommon, style, button }

The package provides the implementation of the Sign-In button with CSS and HTML. It was added in favour of the static image button to be able to switch background color on hover, and instead of an SVG button because problems will arise when placing SVG into an a element.

| Button | Source |
| --------------------------------------- | -------------------------------------------------------------------------------------------- |
| !Default Button | The default Linked In button from https://developer.linkedin.com/downloads. |
| !Idio Linkedin Button | Idio's button CSS+HTML implementation. It supports hover, active and focus` properties. |

Copyright

(c) [Idio][1] 2019

[1]: https://idio.cc