piral-oidc 1.0.0-pre.2028 → 1.0.0

package/src/create.test.ts

@@ -1,5 +1,5 @@
 import { createOidcApi } from './create';
-import { PiralOidcApi } from './types';
+import { PiletOidcApi } from './types';
 
 declare module 'piral-oidc/src/types' {
   interface PiralCustomOidcProfile {
@@ -33,7 +33,7 @@ describe('Piral-Oidc create module', () => {
   });
 
   it('api.getAccessToken() should return the client.token()', () => {
-    const api = createOidcApi(mock)(context) as PiralOidcApi;
+    const api = createOidcApi(mock)(context) as PiletOidcApi;
     expect(api.getAccessToken()).toBe(mockToken);
   });
 
@@ -42,7 +42,7 @@ describe('Piral-Oidc create module', () => {
   });
 
   it('api.getProfile() should return client.account()', async () => {
-    const api = createOidcApi(mock)(context) as PiralOidcApi;
+    const api = createOidcApi(mock)(context) as PiletOidcApi;
     const profile = await api.getProfile();
     expect(profile).toEqual(mockProfile);
     // This is asserting the custom claims works, otherwise we would get a type error

package/src/create.ts

@@ -1,10 +1,10 @@
 import { PiralPlugin } from 'piral-core';
-import { PiralOidcApi, OidcClient } from './types';
+import { PiletOidcApi, OidcClient } from './types';
 
 /**
  * Creates new Pilet API extensions for the integration of OpenID Connect.
  */
-export function createOidcApi(client: OidcClient): PiralPlugin<PiralOidcApi> {
+export function createOidcApi(client: OidcClient): PiralPlugin<PiletOidcApi> {
   return (context) => {
     context.on('before-fetch', client.extendHeaders);
 

package/src/setup.ts

@@ -31,12 +31,18 @@ export function setupOidcClient(config: OidcConfig): OidcClient {
     signInRedirectParams,
     postLogoutRedirectUri = location.origin,
     responseType,
+    responseMode,
     scopes,
     restrict = false,
     parentName,
     appUri,
     logLevel,
     userStore,
+    extraQueryParams,
+    uiLocales,
+    metadata,
+    metadataUrl,
+    monitorSession,
   } = config;
 
   const isMainWindow = () => (parentName ? parentName === window.parent?.name : window === window.top);
@@ -51,7 +57,13 @@ export function setupOidcClient(config: OidcConfig): OidcClient {
     client_secret: clientSecret,
     response_type: responseType,
     scope: scopes?.join(' '),
-    userStore: userStore,
+    userStore,
+    extraQueryParams,
+    ui_locales: uiLocales,
+    response_mode: responseMode,
+    metadata,
+    metadataUrl,
+    monitorSession,
   });
 
   if (logLevel !== undefined) {
@@ -200,12 +212,16 @@ export function setupOidcClient(config: OidcConfig): OidcClient {
     });
 
   return {
+    _: userManager,
     login() {
       return userManager.signinRedirect(signInRedirectParams);
     },
     logout() {
       return userManager.signoutRedirect();
     },
+    revoke() {
+      return userManager.revokeAccessToken();
+    },
     handleAuthentication,
     extendHeaders(req) {
       if (!restrict) {

package/src/types.ts

@@ -47,6 +47,12 @@ export interface OidcConfig {
    * is used.
    */
   responseType?: string;
+  /**
+   * The response mode, which is usually already configured well
+   * via the responseType. By default, the responseType `code` will
+   * get `query` and responseType `token` will get `fragment`.
+   */
+  responseMode?: string;
   /**
    * The scopes to be used. By default, `openid` is used.
    */
@@ -73,6 +79,26 @@ export interface OidcConfig {
    * This defaults to oidc-client's WebStorageStateStore, using sessionStorage as the internal store
    */
   userStore?: OidcStore;
+  /**
+   * Provides some extra query parameters. These are included in the authorization request.
+   */
+  extraQueryParams?: Record<string, any>;
+  /**
+   * Sets the optiopnal ui_locales parameter to set the language of the login page.
+   */
+  uiLocales?: string;
+  /**
+   * Sets the metadata if the OIDC service does not allow querying it for whatever reason.
+   */
+  metadata?: any;
+  /**
+   * Overrides the default metadata URL if the server does not follow the standard paths.
+   */
+  metadataUrl?: string;
+  /**
+   * Determines if the OIDCS session should be automatically monitored.
+   */
+  monitorSession?: boolean;
 }
 
 /**
@@ -135,6 +161,10 @@ export interface OidcRequest {
 }
 
 export interface OidcClient {
+  /**
+   * The underlying OIDC client.
+   */
+  _: any;
   /**
    * Performs a login. Will do nothing when called from a non-top window.
    */
@@ -143,6 +173,10 @@ export interface OidcClient {
    * Performs a logout.
    */
   logout(): Promise<void>;
+  /**
+   * Revokes the access token.
+   */
+  revoke(): Promise<void>;
   /**
    * Performs a login when the app needs a new token, handles callbacks when on
    * a callback URL, and redirects into the app route if the client was configured with an `appUri`.
@@ -169,7 +203,7 @@ export interface OidcClient {
   extendHeaders(req: OidcRequest): void;
 }
 
-export interface PiralOidcApi {
+export interface PiletOidcApi {
   /**
    * Gets the currently valid access token, if any.
    */
@@ -182,7 +216,7 @@ export interface PiralOidcApi {
 }
 
 declare module 'piral-core/lib/types/custom' {
-  interface PiletCustomApi extends PiralOidcApi {}
+  interface PiletCustomApi extends PiletOidcApi {}
 }
 
 /**