@odx/auth 17.2.1 → 18.0.0

package/lib/plugins/core-identity.plugin.d.ts

@@ -1,18 +0,0 @@
-import { AuthPluginFactory } from '../models';
-declare global {
-    namespace OdxAuth {
-        interface AuthPluginResult {
-            email: string;
-            initials: string;
-            username: string;
-        }
-    }
-}
-/**
- * Core identity plugin for authentication.
- *
- * This plugin extracts and processes identity claims from the authentication service.
- *
- * @returns {AuthPluginFactory} A factory function that returns an observable with the processed identity claims.
- */
-export declare const coreIdentityPlugin: AuthPluginFactory;

package/lib/plugins/index.d.ts

@@ -1,3 +0,0 @@
-export * from './core-debug.plugin';
-export * from './core-identity.plugin';
-export * from './user-profile-link.plugin';

package/lib/plugins/user-profile-link.plugin.d.ts

@@ -1,18 +0,0 @@
-import { AuthPluginFactory } from '../models';
-declare global {
-    namespace OdxAuth {
-        interface AuthPluginResult {
-            userProfileUrl: string;
-        }
-    }
-}
-/**
- * A plugin factory that generates a user profile URL plugin.
- *
- * This plugin retrieves the user profile URL from the authentication configuration.
- * If the user profile URL is not specified in the configuration, it falls back to
- * using the default URL for the current environment from `ODX_AUTH_USER_PROFILE_HOSTS`.
- *
- * @returns A function that returns an observable emitting an object containing the user profile URL.
- */
-export declare const userProfileUrlPlugin: AuthPluginFactory;

package/lib/unauth.guard.d.ts

@@ -1,11 +0,0 @@
-import { CanActivateFn } from '@angular/router';
-import { AuthorizedHandler } from './models';
-/**
- * Guard function to prevent unauthorized access to routes.
- *
- * @param {AuthorizedHandler} authorizedHandler - Optional handler to check if the user is authorized.
- * @param {any[] | string} redirectTo - Optional URL or route to redirect unauthorized users to. Can be a string or an array of strings.
- * @param {boolean} isExternal - Optional flag to indicate if the redirection should be external. Defaults to false.
- * @returns {CanActivateFn} - A function that implements the CanActivateFn interface.
- */
-export declare function unauthGuard(authorizedHandler?: AuthorizedHandler, redirectTo?: any[] | string, isExternal?: boolean): CanActivateFn;

package/plugins/service-connect/lib/dtos/get-service-connect-rights-response.dto.d.ts

@@ -1,3 +0,0 @@
-export interface GetServiceConnectRightsResponseDto {
-    rights: string[];
-}

package/plugins/service-connect/lib/dtos/get-service-connect-user-response.dto.d.ts

@@ -1,14 +0,0 @@
-export interface GetServiceConnectUserResponseDto {
-    user_id: string;
-    first_name: string;
-    last_name: string;
-    language_code: string;
-    preferred_language: string;
-    country: string;
-    institution_id: number;
-    institution_name: string;
-    institution_name_2?: string | null;
-    institution_name_3?: string | null;
-    account_number?: string | null;
-    institution_shortname: string;
-}

package/plugins/service-connect/lib/dtos/index.d.ts

@@ -1,2 +0,0 @@
-export * from './get-service-connect-rights-response.dto';
-export * from './get-service-connect-user-response.dto';

package/plugins/service-connect/lib/helpers/build-service-connect-url.d.ts

@@ -1,10 +0,0 @@
-import { AuthEnvironment } from '@odx/auth';
-import { ServiceConnectEnvironment } from '../service-connect.config';
-/**
- * Builds a service connect URL based on the provided environment and endpoints.
- *
- * @param {ServiceConnectEnvironment | AuthEnvironment} environment - The environment configuration which can be either a `ServiceConnectEnvironment` or `AuthEnvironment`.
- * @param {string[]} endpoints - A list of endpoint strings to be appended to the base URL.
- * @returns {string} - The constructed service connect URL as a string.
- */
-export declare function buildServiceConnectUrl(environment: ServiceConnectEnvironment | AuthEnvironment, ...endpoints: string[]): string;

package/plugins/service-connect/lib/helpers/has-roles-or-rights-handler.d.ts

@@ -1,10 +0,0 @@
-import { AuthorizedHandler } from '@odx/auth';
-import { RolesOrRights } from './has-roles-or-rights';
-/**
- * Creates an authorized handler that checks if the user has the specified roles or rights.
- *
- * @param {RolesOrRights} rolesOrRights - The roles or rights to check against the user's claims.
- * @returns {AuthorizedHandler} - An handler function that takes user claims and returns a boolean indicating
- *          whether the user has the required roles or rights.
- */
-export declare function hasRolesOrRightsHandler(rolesOrRights: RolesOrRights): AuthorizedHandler;

package/plugins/service-connect/lib/helpers/has-roles-or-rights.d.ts

@@ -1,11 +0,0 @@
-export type Right = string | number;
-export type Role = Right[];
-export type RolesOrRights = Array<Role | Right>;
-/**
- * Checks if the user has any of the specified roles or rights.
- *
- * @param {Right[]} userRights - An array of rights that the user possesses.
- * @param {RolesOrRights} rolesOrRights - An array of roles or rights to check against. A role is represented as an array of rights.
- * @returns {boolean} - `true` if the user has any of the specified roles or rights, otherwise `false`.
- */
-export declare function hasRolesOrRights(userRights: Right[], rolesOrRights: RolesOrRights): boolean;

package/plugins/service-connect/lib/helpers/index.d.ts

@@ -1,4 +0,0 @@
-export * from './build-service-connect-url';
-export * from './has-roles-or-rights';
-export * from './has-roles-or-rights-handler';
-export * from './service-connect-plugin-factory';

package/plugins/service-connect/lib/helpers/service-connect-plugin-factory.d.ts

@@ -1,20 +0,0 @@
-import { AuthPluginFactory } from '@odx/auth';
-import { ServiceConnectEnvironment } from '../service-connect.config';
-export interface ServiceConnectPluginOptions<Dto = unknown> {
-    environment?: ServiceConnectEnvironment;
-    additionalClaims?: (dto: (Dto & Record<string, unknown>) | null) => Partial<OdxAuth.AuthPluginResult>;
-}
-export interface ServiceConnectPluginFactoryOptions<Dto> {
-    endpoint: string[];
-    parseResponse: (res: Dto | null) => Partial<OdxAuth.AuthPluginResult>;
-    defaultValue?: Partial<OdxAuth.AuthPluginResult>;
-    setup?: (pluginOptions?: ServiceConnectPluginOptions<Dto>) => void;
-}
-export type ServiceConnectPluginFactory<Dto = unknown> = (pluginOptions?: ServiceConnectPluginOptions<Dto>) => AuthPluginFactory;
-/**
- * Creates a plugin factory for fetching and parsing service connect data.
- *
- * @param {ServiceConnectPluginFactoryOptions<Dto>} options - The options for the service connect plugin factory.
- * @returns {ServiceConnectPluginFactory} - A function that creates an auth plugin factory for fetching and parsing service connect data.
- */
-export declare function serviceConnectPluginFactory<Dto = unknown>(options: ServiceConnectPluginFactoryOptions<Dto>): ServiceConnectPluginFactory<Dto>;

package/plugins/service-connect/lib/service-connect-rights.directive.d.ts

@@ -1,21 +0,0 @@
-import { RolesOrRights } from './helpers';
-import * as i0 from "@angular/core";
-import * as i1 from "@odx/auth";
-/**
- * A directive that extends the functionality of the `AuthDirective` to handle
- * roles or rights for service connection authorization.
- *
- * @see AuthDirective
- *
- * This directive should be used on an `ng-template` element with the selector
- * `odxAuthServiceConnectRights`.
- */
-export declare class ServiceConnectRightsDirective {
-    private readonly authDirective;
-    /**
-     * Sets the roles or rights that the user must have to display the content.
-     */
-    set rolesOrRights(value: RolesOrRights | null | undefined);
-    static ɵfac: i0.ɵɵFactoryDeclaration<ServiceConnectRightsDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<ServiceConnectRightsDirective, "ng-template[odxAuthServiceConnectRights]", never, { "rolesOrRights": { "alias": "odxAuthServiceConnectRights"; "required": false; }; }, {}, never, never, true, [{ directive: typeof i1.AuthDirective; inputs: { "odxAuthElse": "odxAuthServiceConnectRightsElse"; }; outputs: {}; }]>;
-}

package/plugins/service-connect/lib/service-connect-rights.guard.d.ts

@@ -1,11 +0,0 @@
-import { CanActivateFn } from '@angular/router';
-import { RolesOrRights } from './helpers';
-/**
- * A guard function to check if the user has the required roles or rights to access a route.
- *
- * @param {RolesOrRights} rolesOrRights - The roles or rights required to access the route.
- * @param {string | any[]} redirectTo - (Optional) The route to redirect to if the user does not have the required roles or rights.
- * @param {boolean} isExternal - (Optional) A flag indicating if the redirection is to an external URL. Defaults to `false`.
- * @returns {CanActivateFn} - A function that checks the user's roles or rights and handles redirection if necessary.
- */
-export declare function serviceConnectRightsGuard(rolesOrRights: RolesOrRights, redirectTo?: string | any[], isExternal?: boolean): CanActivateFn;

package/plugins/service-connect/lib/service-connect-rights.plugin.d.ts

@@ -1,18 +0,0 @@
-import { GetServiceConnectRightsResponseDto } from './dtos';
-import { Right } from './helpers';
-declare global {
-    namespace OdxAuth {
-        interface AuthPluginResult {
-            rights: Right[];
-        }
-    }
-}
-/**
- * A plugin for fetching and parsing service connect rights.
- *
- * This plugin uses the `serviceConnectPluginFactory` to create a plugin that fetches user rights
- * from the specified endpoint and parses the response to extract the rights.
- *
- * @see {serviceConnectPluginFactory}
- */
-export declare const serviceConnectRightsPlugin: import("./helpers").ServiceConnectPluginFactory<GetServiceConnectRightsResponseDto>;

package/plugins/service-connect/lib/service-connect-user-language.plugin.d.ts

@@ -1,24 +0,0 @@
-import { GetServiceConnectUserResponseDto } from './dtos';
-/**
- * Gets the preferred language from a service connect user response.
- *
- * @param {GetServiceConnectUserResponseDto | null} res - The service connect user response.
- * @returns {string | undefined} - The language or undefined.
- */
-export declare function getServiceConnectUserLanguage(res?: GetServiceConnectUserResponseDto | null): string | undefined;
-/**
- * Gets the language code from a service connect user response.
- *
- * @param {GetServiceConnectUserResponseDto | null} res - The service connect user response.
- * @returns {string | undefined} - The language code or undefined.
- */
-export declare function getServiceConnectUserLanguageCode(res?: GetServiceConnectUserResponseDto | null): string | undefined;
-/**
- * A plugin for fetching and parsing the user's preferred language from service connect.
- *
- * This plugin uses the `serviceConnectPluginFactory` to create a plugin that fetches the user's preferred language
- * from the user endpoint and parses the response to extract the preferred language.
- *
- * @see {serviceConnectPluginFactory}
- */
-export declare const serviceConnectUserLanguagePlugin: import("./helpers").ServiceConnectPluginFactory<GetServiceConnectUserResponseDto>;

package/plugins/service-connect/lib/service-connect-user-profile.plugin.d.ts

@@ -1,23 +0,0 @@
-import { GetServiceConnectUserResponseDto } from './dtos';
-declare global {
-    namespace OdxAuth {
-        interface AuthPluginResult {
-            country?: string;
-            institutionId?: number;
-            institutionName?: string;
-            institutionName2?: string;
-            institutionName3?: string;
-            institutionShortname?: string;
-            accountNumber?: string;
-        }
-    }
-}
-/**
- * A plugin for fetching and parsing the user's profile from service connect.
- *
- * This plugin uses the `serviceConnectPluginFactory` to create a plugin that fetches the user's profile
- * from the user endpoint and parses the response to extract the user's profile information.
- *
- * @see {serviceConnectPluginFactory}
- */
-export declare const serviceConnectUserProfilePlugin: import("./helpers").ServiceConnectPluginFactory<GetServiceConnectUserResponseDto>;

package/plugins/service-connect/lib/service-connect.config.d.ts

@@ -1,15 +0,0 @@
-import { AuthEnvironment } from '@odx/auth';
-export type ServiceConnectEnvironment = {
-    custom: string;
-};
-export declare const ServiceConnectEnvironments: Record<AuthEnvironment, string>;
-export declare const ServiceConnectScopes: {
-    BASE: string;
-    PROFILE: string;
-    RIGHTS: string;
-    INSTITUTION: string;
-};
-export declare const ServiceConnectEndpoints: {
-    user: string;
-    userRights: string;
-};