@masterteam/gateway-auth 0.0.16 → 0.0.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@masterteam/gateway-auth",
-  "version": "0.0.16",
+  "version": "0.0.18",
   "publishConfig": {
     "directory": "../../../dist/masterteam/gateway-auth",
     "linkDirectory": true,
@@ -15,7 +15,7 @@
     "@ngxs/store": "^20.1.0",
     "rxjs": "^7.8.2",
     "@masterteam/brand-display": "^0.0.11",
-    "@masterteam/components": "^0.0.167",
+    "@masterteam/components": "^0.0.169",
     "@masterteam/icons": "^0.0.15"
   },
   "repository": {

package/types/masterteam-gateway-auth.d.ts

@@ -1,4 +1,4 @@
-import { HttpContextToken, HttpInterceptorFn, HttpRequest } from '@angular/common/http';
+import { HttpClient, HttpContextToken, HttpInterceptorFn, HttpRequest } from '@angular/common/http';
 import * as _angular_core from '@angular/core';
 import { InjectionToken, OnInit } from '@angular/core';
 import { StateContext } from '@ngxs/store';
@@ -80,6 +80,7 @@ interface GatewayLoginResponse {
 interface GatewayLoginRequest {
     userName: string;
     password: string;
+    applicationCode?: string;
     isEncrypted?: boolean;
     deviceToken?: string;
     recaptchaToken?: string;
@@ -133,6 +134,7 @@ interface GatewayExternalTokenExchangeRequest {
     subjectToken: string;
     subjectTokenType: 'urn:ietf:params:oauth:token-type:access_token';
     deviceToken?: string;
+    applicationCode?: string;
 }
 interface GatewayNafathStartRequest {
     nationalId: string;
@@ -183,6 +185,32 @@ interface GatewayMappedUser {
     tempSessionId?: string;
     id?: string;
 }
+interface GatewayApplicationListItem {
+    applicationCode: string;
+    applicationName?: string;
+    launchUrl?: string;
+}
+interface GatewayApplicationsData {
+    applications: GatewayApplicationListItem[];
+}
+interface GatewayApplicationLaunchData {
+    applicationCode: string;
+    applicationName?: string;
+    launchUrl?: string;
+    tokens: GatewayAuthTokens;
+}
+interface GatewayApplicationContextData {
+    applicationCode: string;
+}
+interface GatewayAppSession {
+    applicationCode: string;
+    applicationName?: string;
+    launchUrl?: string;
+    accessToken: string;
+    refreshToken: string;
+    accessTokenExpiresAt: string | null;
+    refreshTokenExpiresAt: string | null;
+}
 
 declare const GATEWAY_AUTH_DEVICE_TOKEN = "web-app";
 declare const GATEWAY_AUTH_DEVICE_TOKEN_STORAGE_KEY = "masterteam.gateway-auth.device-token";
@@ -195,9 +223,12 @@ declare const GATEWAY_AUTH_ENDPOINTS: {
     readonly resendMfa: "auth/2fa/resend";
     readonly refresh: "auth/refresh";
     readonly logout: "auth/logout";
+    readonly meApplications: "auth/me/applications";
+    readonly applicationContext: "public/application-context";
     readonly ssoProviders: "auth/sso/providers";
     readonly ssoExchange: "auth/sso/exchange";
     readonly ssoTokenExchange: "auth/sso/token-exchange";
+    readonly applicationLaunch: (applicationCode: string) => string;
     readonly nafathStart: (providerKey: string) => string;
     readonly nafathStatus: (providerKey: string) => string;
     readonly ssoStart: (providerKey: string) => string;
@@ -206,6 +237,10 @@ declare function isExpired(expireAt?: string | null, skewMs?: number): boolean;
 declare function resolveApiDateValue(value?: GatewayApiDateValue | null): string | null;
 declare function mapGatewayTokens(tokens: GatewayAuthTokens | GatewayRefreshData): GatewayMappedTokens;
 declare function resolveAccessTokenRefreshSkewMs(skewMs?: number | null): number;
+declare function resolveApplicationCodeOption(applicationCode?: string | (() => string | null | undefined) | null): string | null;
+declare function buildApplicationContextUrl(applicationApiBaseUrl: string | null | undefined): string | null;
+declare function clearApplicationContextCache(applicationApiBaseUrl?: string | null): void;
+declare function fetchApplicationContextCode(http: HttpClient, applicationApiBaseUrl: string | null | undefined): Promise<string | null>;
 declare function resolveGatewayDeviceToken(deviceToken?: GatewayDeviceTokenOption | null): string;
 declare function withGatewayAuthNgswBypass(url: string): string;
 declare function readPersistedGatewayAuthTokens(): GatewayAuthTokens | null;
@@ -256,6 +291,8 @@ type AuthRefreshData = GatewayRefreshData;
 type TwoFactorChallenge = GatewayTwoFactorChallenge;
 type SsoProvider = GatewaySsoProvider;
 type Response<T> = GatewayResponse<T>;
+type ApplicationListItem = GatewayApplicationListItem;
+type AppSession = GatewayAppSession;
 type AuthRateLimitScope = 'login' | 'verifyMfa' | 'resendMfa' | 'ssoExchange';
 interface AuthRateLimit {
     retryUntilMs: number | null;
@@ -278,6 +315,10 @@ interface AuthStateModel {
     pendingMfa: TwoFactorChallenge | null;
     ssoProviders: SsoProvider[];
     rateLimit: AuthRateLimit | null;
+    applications: ApplicationListItem[];
+    applicationsLoading: boolean;
+    appSessions: Record<string, AppSession>;
+    appLaunchLoading: Record<string, boolean>;
 }
 declare const AUTH_STATE_DEFAULTS: AuthStateModel;
 declare function sanitizePersistedAuthState(obj: Partial<AuthStateModel> | null): {
@@ -290,6 +331,10 @@ declare function sanitizePersistedAuthState(obj: Partial<AuthStateModel> | null)
     pendingMfa: null;
     ssoProviders: never[];
     rateLimit: AuthRateLimit | null;
+    applications: GatewayApplicationListItem[];
+    applicationsLoading: boolean;
+    appSessions: Record<string, GatewayAppSession>;
+    appLaunchLoading: {};
     user: User | null;
     token: string | null;
     refreshToken: string | null;
@@ -298,6 +343,7 @@ declare function sanitizePersistedAuthState(obj: Partial<AuthStateModel> | null)
 };
 
 type GatewayAuthHookResult = void | null | Observable<unknown> | Promise<unknown>;
+type GatewayApplicationCodeOption = string | (() => string | null | undefined);
 interface GatewayLoginLanguageOption {
     key: string;
     id?: string;
@@ -327,6 +373,9 @@ interface GatewayAuthOptions {
     defaultAuthenticatedRoute?: string | (() => string | null | undefined);
     preserveSsoProvidersOnLogout?: boolean;
     loginPage?: GatewayLoginPageOptions;
+    applicationCode?: GatewayApplicationCodeOption;
+    autoLaunchApplicationOnLogin?: boolean;
+    resolveApplicationCodeForRequest?: (request: HttpRequest<unknown>) => string | null | undefined;
     afterLogin?: (session: GatewayLoginResponse, ctx: StateContext<AuthStateModel>) => GatewayAuthHookResult;
     beforeLocalLogout?: (ctx: StateContext<AuthStateModel>) => GatewayAuthHookResult;
 }
@@ -398,6 +447,40 @@ declare class SetRateLimit {
 declare class ClearRateLimit {
     static readonly type = "[Auth] Clear Rate Limit";
 }
+declare class LoadApplications {
+    static readonly type = "[Auth] Load Applications";
+}
+declare class SetApplications {
+    applications: ApplicationListItem[];
+    static readonly type = "[Auth] Set Applications";
+    constructor(applications: ApplicationListItem[]);
+}
+declare class LaunchApplication {
+    applicationCode: string;
+    returnUrl?: string | undefined;
+    navigate: boolean;
+    static readonly type = "[Auth] Launch Application";
+    constructor(applicationCode: string, returnUrl?: string | undefined, navigate?: boolean);
+}
+declare class SetAppSession {
+    session: AppSession;
+    static readonly type = "[Auth] Set App Session";
+    constructor(session: AppSession);
+}
+declare class UpdateAppTokens {
+    applicationCode: string;
+    tokens: AuthTokens;
+    static readonly type = "[Auth] Update App Tokens";
+    constructor(applicationCode: string, tokens: AuthTokens);
+}
+declare class ClearAppSession {
+    applicationCode: string;
+    static readonly type = "[Auth] Clear App Session";
+    constructor(applicationCode: string);
+}
+declare class ClearAllAppSessions {
+    static readonly type = "[Auth] Clear All App Sessions";
+}
 
 declare class GatewayAuthState {
     private readonly http;
@@ -421,7 +504,12 @@ declare class GatewayAuthState {
     static rateLimit(state: AuthStateModel): AuthRateLimit | null;
     static isAdmin(state: AuthStateModel): boolean;
     static userDetails(state: AuthStateModel): _masterteam_gateway_auth.GatewayUserDetails | null;
+    static applications(state: AuthStateModel): ApplicationListItem[];
+    static applicationsLoading(state: AuthStateModel): boolean;
+    static appSessions(state: AuthStateModel): Record<string, AppSession>;
+    static appLaunchLoading(state: AuthStateModel): Record<string, boolean>;
     login(ctx: StateContext<AuthStateModel>, action: Login): Observable<unknown>;
+    private resolveApplicationCode$;
     verifyMfa(ctx: StateContext<AuthStateModel>, action: VerifyMfa): Observable<unknown>;
     resendMfa(ctx: StateContext<AuthStateModel>): Observable<GatewayResponse<GatewayTwoFactorChallenge> | null>;
     loadSsoProviders(ctx: StateContext<AuthStateModel>): Observable<GatewayResponse<GatewaySsoProvidersData> | null>;
@@ -436,9 +524,18 @@ declare class GatewayAuthState {
     clearPendingMfa(ctx: StateContext<AuthStateModel>): void;
     setRateLimit(ctx: StateContext<AuthStateModel>, action: SetRateLimit): void;
     clearRateLimit(ctx: StateContext<AuthStateModel>): void;
+    loadApplications(ctx: StateContext<AuthStateModel>): Observable<GatewayResponse<GatewayApplicationsData> | null>;
+    setApplications(ctx: StateContext<AuthStateModel>, action: SetApplications): void;
+    launchApplication(ctx: StateContext<AuthStateModel>, action: LaunchApplication): Observable<GatewayResponse<GatewayApplicationLaunchData> | null>;
+    setAppSession(ctx: StateContext<AuthStateModel>, action: SetAppSession): void;
+    updateAppTokens(ctx: StateContext<AuthStateModel>, action: UpdateAppTokens): void;
+    clearAppSession(ctx: StateContext<AuthStateModel>, action: ClearAppSession): void;
+    clearAllAppSessions(ctx: StateContext<AuthStateModel>): void;
+    private removeLoadingFlag;
     private isRateLimitActive;
     private handleRateLimit;
     private handleLoginResponse;
+    private maybeAutoLaunchApplication;
     private get deviceToken();
     private gatewayUrl;
     private gatewayAuthMutationUrl;
@@ -468,6 +565,10 @@ declare class GatewayAuthFacade {
     readonly rateLimit: _angular_core.Signal<_masterteam_gateway_auth.AuthRateLimit | null>;
     readonly isAdmin: _angular_core.Signal<boolean>;
     readonly userDetails: _angular_core.Signal<_masterteam_gateway_auth.GatewayUserDetails | null>;
+    readonly applications: _angular_core.Signal<_masterteam_gateway_auth.GatewayApplicationListItem[]>;
+    readonly applicationsLoading: _angular_core.Signal<boolean>;
+    readonly appSessions: _angular_core.Signal<Record<string, _masterteam_gateway_auth.GatewayAppSession>>;
+    readonly appLaunchLoading: _angular_core.Signal<Record<string, boolean>>;
     readonly hasError: _angular_core.Signal<boolean>;
     readonly isReady: _angular_core.Signal<boolean>;
     readonly userDisplayName: _angular_core.Signal<string>;
@@ -484,6 +585,15 @@ declare class GatewayAuthFacade {
     logout(remote?: boolean): void;
     updateUserData(user: User): void;
     updateTokens(tokens: AuthTokens): void;
+    loadApplications(): void;
+    setApplications(applications: ApplicationListItem[]): void;
+    launchApplication(applicationCode: string, returnUrl?: string, navigate?: boolean): void;
+    setAppSession(session: AppSession): void;
+    updateAppTokens(applicationCode: string, tokens: AuthTokens): void;
+    clearAppSession(applicationCode: string): void;
+    clearAllAppSessions(): void;
+    getAppSession(applicationCode: string): AppSession | null;
+    getAppToken(applicationCode: string): string | null;
     clearError(): void;
     clearPendingMfa(): void;
     clearRateLimit(): void;
@@ -606,5 +716,5 @@ declare class GatewaySsoButtons implements OnInit {
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<GatewaySsoButtons, "mt-gateway-sso-buttons", never, { "dividerLabel": { "alias": "dividerLabel"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
-export { AUTH_STATE_DEFAULTS, ClearError, ClearPendingMfa, ClearRateLimit, ExchangeSsoCode, GATEWAY_AUTH_ACCESS_TOKEN_REFRESH_SKEW_MS, GATEWAY_AUTH_DEVICE_TOKEN, GATEWAY_AUTH_DEVICE_TOKEN_STORAGE_KEY, GATEWAY_AUTH_ENDPOINTS, GATEWAY_AUTH_NGSW_BYPASS_PARAM, GATEWAY_AUTH_OPTIONS, GATEWAY_AUTH_RETRY_CONTEXT, GATEWAY_RATE_LIMIT_ERROR_CODE, GATEWAY_RATE_LIMIT_STATUS, GatewayAuthFacade, GatewayAuthState, GatewayLoginPage, GatewayMfa, GatewaySsoButtons, GatewaySsoCallback, GatewaySsoSession, LoadSsoProviders, Login, LoginFailure, LoginSuccess, Logout, ResendMfa, SetRateLimit, StartSso, UpdateTokens, UpdateUserData, VerifyMfa, buildGatewayUrl, buildSsoStartUrl, createSecureClientState, extractGatewayRateLimitInfo, gatewayAuthInterceptor, getGatewayErrorMessage, hasGatewayTokens, isExpired, isGatewayAuthRequestUrl, mapGatewayTokens, mapGatewayUser, normalizeGatewayBase, readPersistedGatewayAuthTokens, resolveAccessTokenRefreshSkewMs, resolveApiDateValue, resolveGatewayAuthPath, resolveGatewayDeviceToken, sanitizePersistedAuthState, withGatewayAuthNgswBypass };
-export type { ApiDateValue, AuthLoginData, AuthRateLimit, AuthRateLimitScope, AuthRefreshData, AuthStateModel, AuthTokens, BuildSsoStartUrlOptions, GatewayApiDateValue, GatewayAuthHookResult, GatewayAuthOptions, GatewayAuthTokens, GatewayDeviceTokenOption, GatewayExternalTokenExchangeRequest, GatewayLoginLanguageOption, GatewayLoginPageOptions, GatewayLoginRequest, GatewayLoginResponse, GatewayLogoutRequest, GatewayMappedTokens, GatewayMappedUser, GatewayNafathStartData, GatewayNafathStartRequest, GatewayNafathStatusData, GatewayNafathStatusRequest, GatewayPlatform, GatewayRateLimitInfo, GatewayRefreshData, GatewayRefreshRequest, GatewayResendMfaRequest, GatewayResponse, GatewaySsoExchangeRequest, GatewaySsoFlow, GatewaySsoProtocol, GatewaySsoProvider, GatewaySsoProvidersData, GatewayTwoFactorChallenge, GatewayUserDetails, GatewayVerifyMfaRequest, LoginRequest, Response, SsoProvider, TwoFactorChallenge, User, UserDetails };
+export { AUTH_STATE_DEFAULTS, ClearAllAppSessions, ClearAppSession, ClearError, ClearPendingMfa, ClearRateLimit, ExchangeSsoCode, GATEWAY_AUTH_ACCESS_TOKEN_REFRESH_SKEW_MS, GATEWAY_AUTH_DEVICE_TOKEN, GATEWAY_AUTH_DEVICE_TOKEN_STORAGE_KEY, GATEWAY_AUTH_ENDPOINTS, GATEWAY_AUTH_NGSW_BYPASS_PARAM, GATEWAY_AUTH_OPTIONS, GATEWAY_AUTH_RETRY_CONTEXT, GATEWAY_RATE_LIMIT_ERROR_CODE, GATEWAY_RATE_LIMIT_STATUS, GatewayAuthFacade, GatewayAuthState, GatewayLoginPage, GatewayMfa, GatewaySsoButtons, GatewaySsoCallback, GatewaySsoSession, LaunchApplication, LoadApplications, LoadSsoProviders, Login, LoginFailure, LoginSuccess, Logout, ResendMfa, SetAppSession, SetApplications, SetRateLimit, StartSso, UpdateAppTokens, UpdateTokens, UpdateUserData, VerifyMfa, buildApplicationContextUrl, buildGatewayUrl, buildSsoStartUrl, clearApplicationContextCache, createSecureClientState, extractGatewayRateLimitInfo, fetchApplicationContextCode, gatewayAuthInterceptor, getGatewayErrorMessage, hasGatewayTokens, isExpired, isGatewayAuthRequestUrl, mapGatewayTokens, mapGatewayUser, normalizeGatewayBase, readPersistedGatewayAuthTokens, resolveAccessTokenRefreshSkewMs, resolveApiDateValue, resolveApplicationCodeOption, resolveGatewayAuthPath, resolveGatewayDeviceToken, sanitizePersistedAuthState, withGatewayAuthNgswBypass };
+export type { ApiDateValue, AppSession, ApplicationListItem, AuthLoginData, AuthRateLimit, AuthRateLimitScope, AuthRefreshData, AuthStateModel, AuthTokens, BuildSsoStartUrlOptions, GatewayApiDateValue, GatewayAppSession, GatewayApplicationCodeOption, GatewayApplicationContextData, GatewayApplicationLaunchData, GatewayApplicationListItem, GatewayApplicationsData, GatewayAuthHookResult, GatewayAuthOptions, GatewayAuthTokens, GatewayDeviceTokenOption, GatewayExternalTokenExchangeRequest, GatewayLoginLanguageOption, GatewayLoginPageOptions, GatewayLoginRequest, GatewayLoginResponse, GatewayLogoutRequest, GatewayMappedTokens, GatewayMappedUser, GatewayNafathStartData, GatewayNafathStartRequest, GatewayNafathStatusData, GatewayNafathStatusRequest, GatewayPlatform, GatewayRateLimitInfo, GatewayRefreshData, GatewayRefreshRequest, GatewayResendMfaRequest, GatewayResponse, GatewaySsoExchangeRequest, GatewaySsoFlow, GatewaySsoProtocol, GatewaySsoProvider, GatewaySsoProvidersData, GatewayTwoFactorChallenge, GatewayUserDetails, GatewayVerifyMfaRequest, LoginRequest, Response, SsoProvider, TwoFactorChallenge, User, UserDetails };