npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@dopry/svelte-oidc

v1.1.0

Published

Svelte OIDC Component Library

Downloads

187

Readme

svelte-oidc

An Oidc Client Component for Svelte.

Try out the demo

Getting Started

Setup an OIDC Sever

  • https://www.ory.sh/
  • https://www.keycloak.org/
  • https://www.okta.com/
  • http://auth0.com/

Get the authority and client_id

npm install @dopry/svelte-oidc

App.svelte

# App.svelte
import {
  OidcContext,
  LoginButton,
  LogoutButton,
  RefreshTokenButton,
  authError,
  accessToken,
  idToken,
  isAuthenticated,
  isLoading,
  login,
  logout,
  userInfo,
} from '@dopry/svelte-oidc';

const metadata = {
            // added to overcome missing value in auth0 .well-known/openid-configuration
            // see: https://github.com/IdentityModel/oidc-client-js/issues/1067
            // see: https://github.com/IdentityModel/oidc-client-js/pull/1068
            end_session_endpoint: `process.env.OIDC_ISSUER/v2/logout?client_id=process.env.OIDC_CLIENT_ID`,
        };
</script>

<OidcContext
 issuer="https://dev-hvw40i79.auth0.com"
 client_id="aOijZt2ug6Ovgzp0HXdF23B6zxwA6PaP"
 redirect_uri="https://darrelopry.com/svelte-oidc/"
 post_logout_redirect_uri="https://darrelopry.com/svelte-oidc/"
 metadata={metadata}
 extraOptions={{
   mergeClaims: true,
   resource: "some_identifier",
 }}
 >

  <LoginButton>Login</LoginButton>
  <LogoutButton>Logout</LogoutButton>
  <RefreshTokenButton>RefreshToken</RefreshTokenButton><br />
  <pre>isLoading: {$isLoading}</pre>
  <pre>isAuthenticated: {$isAuthenticated}</pre>
  <pre>authToken: {$accessToken}</pre>
  <pre>idToken: {$idToken}</pre>
  <pre>userInfo: {JSON.stringify($userInfo, null, 2)}</pre>
  <pre>authError: {$authError}</pre>
</OidcContext>

Sapper/SSR

This component does not natively support SSR nor can it be used for authentication in server side rendered contexts. It can be used within SSR applications as long as it is acceptable for all authentication to be client side. In order to use for client side auth in an SSR application you will need to ensure it is not rendered server side as follows.

{#if process.browser} <OidcContext> ..... </OidcContext> {/if}

SvelteKit/SSR

Same as what is needed for Sapper (see above section). To do this, we need to import in the script section:

import { browser } from '$app/env';

And in the main:

{#if browser} <OidcContext> ..... </OidcContext> {/if}

Contributing

Contributors are Welcome. There is a lot of value in a vendor neutral OIDC component for use by the Svelte and Sapper community. As a developer and product manager, I have needed to switch between Okta, Auth0, KeyCloak, IdentityServer, and Ory on multiple occasions. Vendor specific libraries are usually riddled with vendor specific assumptions that make the migration hard.

How to Help!

  • Better Documentation
  • Helping with the Issue Queue (support, good bug report, resolving bugs)
  • SSR Support
  • Automated Testing of all major identity providers

PRs Welcome!

Docs

Components

  • OidcContext - component to initiate the OIDC client. You only need one instance in your DOM tree at the root.

    Attributes:

    • issuer - OIDC Authority/issuer/base url for .well-known/openid-configuration
    • client_id - OAuth ClientId
    • redirect_uri - default: window.location.href
    • post_logout_redirect_uri - override the default url that OIDC will redirect to after logout. default: window.location.href
    • metadata - set default metadata or metadata missing from authority.
    • extraOptions - An object of extra options that will be passed to the underlying OpenID Connect client. Valid values are available here.
  • LoginButton - log out the current context

    Attributes:

    • preserve_route - tell the callback handler to return to the current url after login. default: true
    • callback_url - override the context callback_url
  • LogoutButton - log in the current context

    Attributes:

    • logout_url - override the context logout_url
  • RefreshTokenButton - refresh the current token

Functions

  • login(oidcPromise, preseveRoute = true, callback_url = null) - begin a user login.
  • logout(oidcPromise, logout_url = null) - logout a user.
  • refreshToken(oidcPromise) - function to refresh a token.

Stores

  • isLoading - if true OIDC Context is still loading.
  • isAuthenticated - true if user is currently authenticated
  • accessToken - access token for connecting to apis.
  • idToken - identity token for getting user info easily.
  • userInfo - the currently logged in user's info from OIDC userInfo endpoint
  • authError - the last authentication error.

Constants

  • OIDC_CONTEXT_CALLBACK_URL
  • OIDC_CONTEXT_CLIENT_PROMISE - key for the OIDC client in setContext/getContext.
  • OIDC_CONTEXT_LOGOUT_URL,

Development

npm run showcase:dev

Release

use semver

  1. npm publish
  2. npm run showcase:build
  3. npm run showcase:publish