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

@awesome-cordova-library/oidc

v1.0.0

Published

OIDC cordova plugin.

Downloads

269

Readme


id: oidc title: OIDC tags:

  • cordova
  • capacitor
  • ionic
  • javascript
  • typescript
  • plugin
  • oidc
  • auth

OIDC

Online documentation

Github documentation

Installation

Cordova

cordova plugin add https://github.com/mi-corporation/cordova-plugin-oidc-basic.git --variable ANDROID_REDIRECT_SCHEME=com.example.myapp
npm install @awesome-cordova-library/oidc

Capacitor / Ionic

npm install https://github.com/mi-corporation/cordova-plugin-oidc-basic.git
npm install @awesome-cordova-library/oidc
npx cap sync

Vanilla

Declaration

export declare type OIDCRequest = {
  configuration: {
    authorizationEndpoint: string;
  };
  clientId: string;
  scope: string;
  state: string;
  redirectUrl: string;
  responseType: string;
  accesTokenExpirationDate: number;
  tokenType: string;
  idToken: string;
  additionalParameters: string;
  nonce: string;
  codeVerifier: string;
  codeChallenge: string;
  codeChallengeMethod: string;
  error: string;
  errorDescription: string;
  errorUrl: string;
  idTokenHint: string;
  postLogoutRedirectUrl: string;
};
export declare type ErrorType = {
  UNSENDABLE_REQUEST: 'OIDC_UNSENDABLE_REQUEST';
  ERROR_RESPONSE: 'OIDC_ERROR_RESPONSE';
  INVALID_RESPONSE: 'OIDC_INVALID_RESPONSE';
  HTTP_ERROR: 'OIDC_HTTP_ERROR';
  USER_CANCELLED: 'OIDC_USER_CANCELLED';
  UNEXPECTED_ERROR: 'OIDC_UNEXPECTED_ERROR';
};
/**
 * @author AZOULAY Jordan<[email protected]>
 * OIDC Cordova plugin
 * Also, check out {@link https://github.com/mi-corporation/cordova-plugin-oidc-basic Github}
 * @requires module:https://github.com/mi-corporation/cordova-plugin-oidc-basic.git
 */
export default class OIDC {
  static presentAuthorizationRequest(
    req: Partial<OIDCRequest>,
    success: (response: Partial<OIDCRequest>) => void,
    error: (error: { message: string; oidcType: string; oidcDetails: string; oidcResponse: string }) => void,
  ): void;
  static presentEndSessionRequest(
    req: Partial<OIDCRequest>,
    success: (response: Partial<OIDCRequest>) => void,
    error: (error: { message: string; oidcType: string; oidcDetails: string }) => void,
  ): void;
  static warnPluginIsUnInstallOrIncompatible(): void;
}

Usages

import OIDC from '@awesome-cordova-library/oidc';
var req = {
  configuration: {
    authorizationEndpoint: 'https://my-authorization-endpoint/authorize',
  },
  clientId: 'my-client-id',
  scope: 'openid',
  state: 'my-state', // or leave absent and the plugin will generate random state by default
  redirectUrl: 'my-redirect-url', // see notes on redirectUrl below
  responseType: 'code', // authorization code flow
};
// Initiate authorization request
OIDC.presentAuthorizationRequest(
  req,
  function (resp) {
    // Success
    // Use the following info to perform your token request:
    // resp.authorizationCode -- The authorization code
    // resp.request.codeVerifier -- The codeVerifier. Generated by the plugin (currently no option to pass in or disable PKCE). Needed as part of the token request.
    // resp.request.nonce -- The nonce. Generated by the plugin (currently no option to pass in or disable). Needed as part of ID token validation.
  },
  function (err) {
    // Error. Inspect err.oidcType to see what kind. See below for more on errors and error types.
    // Example of handling a specific error type:
    if (err.oidcType === cordova.plugins.oidc.basic.ErrorType.USER_CANCELLED) {
      // User cancelled the authorizationr request
    }
    // Can handle other error types as needed
  },
);

React

Declaration

const useOIDC: () => {
  presentAuthorizationRequest: (req: Partial<OIDCRequest>) => Promise<Partial<OIDCRequest>>;
  presentEndSessionRequest: (req: Partial<OIDCRequest>) => Promise<Partial<OIDCRequest>>;
};

Usages

import { useMemo } from 'react';
import useOIDC from '@awesome-cordova-library/oidc/lib/react';

function App() {
  const req = useMemo(
    {
      configuration: {
        authorizationEndpoint: 'https://my-authorization-endpoint/authorize',
      },
      clientId: 'my-client-id',
      scope: 'openid',
      state: 'my-state', // or leave absent and the plugin will generate random state by default
      redirectUrl: 'my-redirect-url', // see notes on redirectUrl below
      responseType: 'code', // authorization code flow
    },
    [],
  );
  const { presentAuthorizationRequest } = useOIDC();

  return (
    <button
      onClick={() =>
        presentAuthorizationRequest(req)
          .then((resp) => {
            // Success
            // Use the following info to perform your token request:
            // resp.authorizationCode -- The authorization code
            // resp.request.codeVerifier -- The codeVerifier. Generated by the plugin (currently no option to pass in or disable PKCE). Needed as part of the token request.
            // resp.request.nonce -- The nonce. Generated by the plugin (currently no option to pass in or disable). Needed as part of ID token validation.
          })
          .catch((err) => {
            // Error. Inspect err.oidcType to see what kind. See below for more on errors and error types.
            // Example of handling a specific error type:
            if (err.oidcType === cordova.plugins.oidc.basic.ErrorType.USER_CANCELLED) {
              // User cancelled the authorizationr request
            }
            // Can handle other error types as needed
          })
      }
    >
      Login
    </button>
  );
}