@acorex-platform/module-auth-client 0.0.15

package/types/acorex-platform-module-auth-client.d.ts

@@ -0,0 +1,390 @@
+import { AXPMultiLanguageString, AXPActionMenuItem } from '@acorex-platform/framework-shared/core';
+import * as i0 from '@angular/core';
+import { InjectionToken } from '@angular/core';
+import * as _acorex_platform_framework_client_core from '@acorex-platform/framework-client/core';
+import { AXPDataSourceDefinitionProvider, AXPDataSourceDefinition } from '@acorex-platform/framework-client/core';
+import * as _acorex_platform_module_auth_client from '@acorex-platform/module-auth-client';
+import { AXMSecurityManagementDeviceSessionsEntityModel } from '@acorex-platform/module-security-management-client/contracts';
+import { AXDataSourceFilterOption } from '@acorex/cdk/common';
+import * as i2 from '@acorex-platform/framework-client/common';
+import { AXPErrorHandler } from '@acorex-platform/framework-client/common';
+import { AuthConfig } from 'angular-oauth2-oidc';
+import * as i1 from '@angular/router';
+import { CanActivateFn } from '@angular/router';
+import * as i1$2 from '@angular/common';
+import * as i1$1 from '@acorex/core/validation';
+
+declare const PROFILE_PAGE_GROUPS_HOOK = "profile-page.groups";
+declare const PROFILE_PAGE_SECTIONS_HOOK = "profile-page.sections";
+declare const PROFILE_PAGE_HEADER_META_HOOK = "profile-page.header-meta";
+type AXPUserProfileGroupsPayload = {
+    groups: AXPUserProfileGroup[];
+};
+type AXPUserProfileSectionsPayload = {
+    sections: AXPUserProfileSection[];
+};
+type AXPUserProfileHeaderMetaPayload = {
+    items: AXPUserProfileHeaderMetaItem[];
+};
+/** Renders section cards in a configurable grid (default). */
+interface AXPUserProfileGroupSectionsContent {
+    mode: 'sections';
+}
+/** Replaces the entire tab body with a registered page component. */
+interface AXPUserProfileGroupComponentContent {
+    mode: 'component';
+    componentKey: string;
+    pageConfig?: Record<string, unknown>;
+}
+type AXPUserProfileGroupContent = AXPUserProfileGroupSectionsContent | AXPUserProfileGroupComponentContent;
+/** Standard card with title, description, and action buttons. */
+interface AXPUserProfileSectionCardContent {
+    mode: 'card';
+    actions: AXPUserProfileSectionAction[];
+}
+/** Replaces the section slot with a registered page component. */
+interface AXPUserProfileSectionComponentContent {
+    mode: 'component';
+    componentKey: string;
+    pageConfig?: Record<string, unknown>;
+}
+type AXPUserProfileSectionContent = AXPUserProfileSectionCardContent | AXPUserProfileSectionComponentContent;
+/** Grid placement for a section within the 12-column profile sections grid. */
+interface AXPUserProfileSectionLayout {
+    /** 1-based column start on md+ breakpoints. */
+    col?: number;
+    /** Number of columns to span on md+ (default 6). */
+    colSpan?: number;
+    /** Number of grid rows to span (default 1). */
+    rowSpan?: number;
+}
+/** Action on a profile section card. */
+type AXPUserProfileSectionAction = AXPActionMenuItem & {
+    /** Primary action when the section card is clicked (required for multi-action sections). */
+    default?: boolean;
+};
+/** Top tab group on the profile hub. */
+interface AXPUserProfileGroup {
+    id: string;
+    /** URL segment under `/:app/profile/:route`; defaults to `id`. */
+    route?: string;
+    title: AXPMultiLanguageString;
+    icon?: string;
+    priority?: number;
+    /** When omitted, the tab renders its section grid. */
+    content?: AXPUserProfileGroupContent;
+}
+/** Profile hub section contributed by modules. */
+interface AXPUserProfileSection {
+    id: string;
+    groupId: string;
+    title?: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString;
+    icon?: string;
+    priority?: number;
+    feature?: string;
+    layout?: AXPUserProfileSectionLayout;
+    content?: AXPUserProfileSectionContent;
+    /** Used when `content` is omitted (card mode). */
+    actions?: AXPUserProfileSectionAction[];
+    /** Optional contextual block shown instead of the section description. */
+    insights?: AXPUserProfileSectionInsight[];
+}
+/** Contextual detail row on a profile section card. */
+interface AXPUserProfileSectionInsight {
+    id: string;
+    icon?: string;
+    /** Plain line shown when no date is set. */
+    text?: string;
+    /** Date value formatted in the template when valid. */
+    date?: Date;
+    /** Optional prefix shown before a formatted relative date. */
+    datePrefix?: AXPMultiLanguageString;
+}
+/** Extra row in the profile page header (label + value). */
+interface AXPUserProfileHeaderMetaItem {
+    id: string;
+    label: AXPMultiLanguageString;
+    value: AXPMultiLanguageString;
+    icon?: string;
+    priority?: number;
+}
+/** Resolves section content; top-level `actions` imply card mode. */
+declare function resolveUserProfileSectionContent(section: AXPUserProfileSection): AXPUserProfileSectionContent;
+/** Whether the group renders a full-tab component instead of sections. */
+declare function isUserProfileGroupComponent(group: AXPUserProfileGroup): boolean;
+/** Visible actions on a section card. */
+declare function visibleUserProfileSectionActions(actions: AXPUserProfileSectionAction[]): AXPUserProfileSectionAction[];
+/** Default card action: explicit `default`, otherwise the first visible action. */
+declare function resolveDefaultUserProfileSectionAction(actions: AXPUserProfileSectionAction[]): AXPUserProfileSectionAction | undefined;
+
+type AXPUserAvatarStorageTarget = {
+    kind: 'person';
+    personId: string;
+    userId: string;
+} | {
+    kind: 'user';
+    userId: string;
+};
+/**
+ * Client-side profile photo operations for self-service flows.
+ * Bidirectional Person ↔ User sync runs on the server via HCM avatar middleware.
+ */
+declare class AXPUserAvatarSyncService {
+    private readonly entityService;
+    private readonly fileStorage;
+    private readonly sessionService;
+    private readonly identityService;
+    private readonly userAvatarService;
+    resolveStorageTarget(userId: string): Promise<AXPUserAvatarStorageTarget>;
+    getCurrentAvatarRef(userId: string): Promise<string | null>;
+    getCurrentAvatarBlob(userId: string): Promise<Blob | null>;
+    uploadAndSetAvatar(userId: string, file: File): Promise<string>;
+    removeAvatar(userId: string): Promise<void>;
+    /** Keeps session, avatar cache, and shell avatars in sync after any avatar change. */
+    notifyAvatarChanged(userId: string, avatar: string | null): Promise<void>;
+    private refreshClientDisplay;
+    private personData;
+    private userData;
+    private findPersonByUserId;
+    private safeRemoveFile;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXPUserAvatarSyncService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXPUserAvatarSyncService>;
+}
+
+/**
+ * Registers auth module data source definitions.
+ */
+declare class AXMAuthDataSourceProvider implements AXPDataSourceDefinitionProvider {
+    private readonly userActivity;
+    items(): Promise<_acorex_platform_framework_client_core.AXPDataSourceDefinition<_acorex_platform_module_auth_client.AXPUserActivityDataSourceItem>[]>;
+}
+
+type AXPUserActivityLevel = 0 | 1 | 2 | 3 | 4;
+interface AXPUserActivityDay {
+    date: string;
+    count: number;
+    level: AXPUserActivityLevel;
+}
+interface AXPUserActivityWeek {
+    days: AXPUserActivityDay[];
+}
+interface AXPUserActivityStats {
+    longestStreak: number;
+    avgPerDay: number;
+    avgPerWeek: number;
+    total: number;
+}
+/** Single payload row returned by {@link AXMAuthDataSourceKeys.UserActivity}. */
+interface AXPUserActivityDataSourceItem {
+    id: string;
+    userId: string;
+    startDate: string;
+    endDate: string;
+    weeks: AXPUserActivityWeek[];
+    stats: AXPUserActivityStats;
+}
+interface AXPUserActivityLoadParams {
+    userId: string;
+    startDate: Date;
+    endDate: Date;
+}
+
+declare const AUTH_USER_ACTIVITY_DEFAULT_WEEKS = 53;
+declare function resolveDefaultUserActivityDateRange(weeksToShow?: number, referenceDate?: Date): {
+    startDate: Date;
+    endDate: Date;
+};
+/** Counts sign-in events per calendar day from device session rows. */
+declare function aggregateDailySessionCounts(sessions: ReadonlyArray<AXMSecurityManagementDeviceSessionsEntityModel>, params: AXPUserActivityLoadParams): Map<string, number>;
+declare function countToActivityLevel(count: number): AXPUserActivityLevel;
+declare function buildUserActivityWeeks(params: AXPUserActivityLoadParams, dailyCounts: ReadonlyMap<string, number>): AXPUserActivityWeek[];
+declare function computeUserActivityStats(weeks: AXPUserActivityWeek[]): AXPUserActivityStats;
+declare function buildUserActivityDataSourceItem(params: AXPUserActivityLoadParams, sessions: ReadonlyArray<AXMSecurityManagementDeviceSessionsEntityModel>): AXPUserActivityDataSourceItem;
+declare function formatCompactActivityCount(value: number): string;
+
+declare function extractUserActivityUserId(filter: AXDataSourceFilterOption | undefined): string | undefined;
+declare function extractUserActivityStartDate(filter: AXDataSourceFilterOption | undefined): Date | undefined;
+declare function extractUserActivityEndDate(filter: AXDataSourceFilterOption | undefined): Date | undefined;
+
+/** Contribution-style user activity heatmap derived from device session sign-in dates. */
+declare class AXMUserActivityDataSourceDefinition implements AXPDataSourceDefinitionProvider {
+    private readonly entityService;
+    items(): Promise<AXPDataSourceDefinition<AXPUserActivityDataSourceItem>[]>;
+    private loadUserSessions;
+}
+
+declare class AXMAuthErrorHandler implements AXPErrorHandler {
+    private router;
+    private layoutService;
+    handleError(error: Error, next: (error: any) => void): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMAuthErrorHandler, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXMAuthErrorHandler>;
+}
+
+declare enum AXMAuthenticationTypes {
+    UsernamePassword = 0,
+    UsernameEmailPassword = 1,
+    EmailPassword = 2,
+    MobilePassword = 3,
+    EmailCode = 4,
+    MobileCode = 5
+}
+declare const AXM_AUTH_CONFIG_TOKEN: InjectionToken<AXMAuthConfigs>;
+interface AXMAuthConfigs {
+    type: AXMAuthenticationTypes;
+    authConfig?: AuthConfig;
+    baseUrl?: string;
+    end_url?: string;
+    signup?: {
+        enable: boolean;
+        url?: string;
+    };
+    signinPage?: {
+        description: string;
+        slogan: string;
+    };
+    defaultStrategyName?: string;
+    idleTimeout?: number;
+}
+declare const AXMDefaultAuthConfigs: AXMAuthConfigs;
+declare function configAuthModule(config?: Partial<AXMAuthConfigs>): AXMAuthConfigs;
+
+/**
+ * Injection token for login page guard.
+ * Apps can provide their own custom guard by providing this token.
+ * If not provided, the default guard (canActivateLogin) will be used.
+ */
+declare const AXM_LOGIN_GUARD_TOKEN: InjectionToken<CanActivateFn>;
+
+declare class AXPAccountModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXPAccountModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AXPAccountModule, never, [typeof i1.RouterModule, typeof _acorex_platform_framework_client_core.AXPComponentSlotModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<AXPAccountModule>;
+}
+
+declare class AXMAuthValidationRulesModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMAuthValidationRulesModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AXMAuthValidationRulesModule, never, [typeof i1$1.AXValidationModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<AXMAuthValidationRulesModule>;
+}
+
+declare class AXMAuthModule {
+    constructor();
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMAuthModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AXMAuthModule, never, [typeof i1$2.CommonModule, typeof i2.AXPCommonModule, typeof i1.RouterModule, typeof AXPAccountModule, typeof AXMAuthValidationRulesModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<AXMAuthModule>;
+}
+
+/**
+ * Guard for login page. Clears incomplete sessions so a prior OAuth attempt
+ * does not leak into the next username/password sign-in.
+ */
+declare const canActivateLogin: CanActivateFn;
+
+/** Slot name for optional extension-provided login buttons (e.g. Google platform login). */
+declare const AUTH_LOGIN_EXTERNAL_PROVIDERS_SLOT = "auth-login-external-providers";
+
+declare class AXPLoginExternalProvidersComponent {
+    protected readonly slotName = "auth-login-external-providers";
+    private readonly slot;
+    hasContent(): boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXPLoginExternalProvidersComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AXPLoginExternalProvidersComponent, "axm-login-external-providers", never, {}, {}, never, never, true, never>;
+}
+
+/**
+ * Tracks user inactivity and locks the session overlay when idle threshold is exceeded.
+ * Requires the Lock When Idle setting to be enabled; unlock uses PIN when configured, otherwise password.
+ * Locked state is stored on {@link AXPSessionService.SESSION_KEY} and survives page refresh and browser restart.
+ */
+declare class AXPIdleLockService {
+    readonly locked: i0.WritableSignal<boolean>;
+    private readonly idleTimeoutMs;
+    private readonly enabled;
+    /** Whether manual or idle lock is available (Lock When Idle setting is enabled). */
+    readonly canLock: i0.Signal<boolean>;
+    private readonly storedPinCode;
+    private lastActivityAt;
+    private lastMouseMoveAt;
+    private idleCheckTimerId;
+    private overlayRef;
+    private overlayOpening;
+    private enableTask;
+    private readonly sessionService;
+    private readonly settingsService;
+    private readonly entityService;
+    private readonly overlayService;
+    private readonly platform;
+    private readonly destroyRef;
+    private readonly injector;
+    constructor();
+    hasPinCode(): boolean;
+    verifyPin(pin: string): boolean;
+    verifyPassword(password: string): Promise<boolean>;
+    unlock(): void;
+    /** Locks the session overlay when Lock When Idle is enabled. */
+    lockScreen(): void;
+    refreshPinState(): Promise<void>;
+    /** Refreshes lock settings and PIN state for menu/commands. */
+    refreshLockState(): Promise<void>;
+    /** Restores the lock overlay when the persisted session is locked. */
+    restoreFromPersistedSession(): Promise<void>;
+    /** Re-evaluates idle lock after the user sets or changes their security PIN. */
+    notifyPinChanged(): Promise<void>;
+    private scheduleEnable;
+    private runEnable;
+    /** Idle lock is active when enabled, or when a persisted lock must be restored/unlocked. */
+    private isOperational;
+    private restoreLockedSession;
+    private handleInactiveSession;
+    private disable;
+    private refreshConfiguration;
+    private applyLockWhenIdleSettingChange;
+    private recordActivity;
+    private lock;
+    private openLockOverlay;
+    private shouldShowLockOverlay;
+    private createLockOverlay;
+    private closeLockOverlay;
+    private startIdleCheck;
+    private stopIdleCheck;
+    private resetUnlockedRuntimeState;
+    private readonly onActivity;
+    private readonly onMouseMove;
+    private attachActivityListeners;
+    private detachActivityListeners;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXPIdleLockService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXPIdleLockService>;
+}
+
+interface AXPLoginHistoryEntry {
+    id: string;
+    device: string;
+    location: string;
+    ipAddress: string;
+    browser: string;
+    status: string;
+    lastLoginDate: Date | string;
+}
+/** Loads sign-in records for the current user from device session storage. */
+declare class AXPLoginHistoryService {
+    private readonly sessionService;
+    private readonly entityService;
+    getEntries(): Promise<AXPLoginHistoryEntry[]>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXPLoginHistoryService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXPLoginHistoryService>;
+}
+
+/** Persists the last self-service password change timestamp per user (client-side). */
+declare class AXPAuthPasswordChangeTrackingService {
+    private readonly sessionService;
+    getLastChangedAt(userId?: string): Date | undefined;
+    recordChange(userId?: string, changedAt?: Date): void;
+    private buildStorageKey;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXPAuthPasswordChangeTrackingService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXPAuthPasswordChangeTrackingService>;
+}
+
+export { AUTH_LOGIN_EXTERNAL_PROVIDERS_SLOT, AUTH_USER_ACTIVITY_DEFAULT_WEEKS, AXMAuthDataSourceProvider, AXMAuthErrorHandler, AXMAuthModule, AXMAuthenticationTypes, AXMDefaultAuthConfigs, AXMUserActivityDataSourceDefinition, AXM_AUTH_CONFIG_TOKEN, AXM_LOGIN_GUARD_TOKEN, AXPAuthPasswordChangeTrackingService, AXPIdleLockService, AXPLoginExternalProvidersComponent, AXPLoginHistoryService, AXPUserAvatarSyncService, PROFILE_PAGE_GROUPS_HOOK, PROFILE_PAGE_HEADER_META_HOOK, PROFILE_PAGE_SECTIONS_HOOK, aggregateDailySessionCounts, buildUserActivityDataSourceItem, buildUserActivityWeeks, canActivateLogin, computeUserActivityStats, configAuthModule, countToActivityLevel, extractUserActivityEndDate, extractUserActivityStartDate, extractUserActivityUserId, formatCompactActivityCount, isUserProfileGroupComponent, resolveDefaultUserActivityDateRange, resolveDefaultUserProfileSectionAction, resolveUserProfileSectionContent, visibleUserProfileSectionActions };
+export type { AXMAuthConfigs, AXPLoginHistoryEntry, AXPUserActivityDataSourceItem, AXPUserActivityDay, AXPUserActivityLevel, AXPUserActivityLoadParams, AXPUserActivityStats, AXPUserActivityWeek, AXPUserAvatarStorageTarget, AXPUserProfileGroup, AXPUserProfileGroupComponentContent, AXPUserProfileGroupContent, AXPUserProfileGroupSectionsContent, AXPUserProfileGroupsPayload, AXPUserProfileHeaderMetaItem, AXPUserProfileHeaderMetaPayload, AXPUserProfileSection, AXPUserProfileSectionAction, AXPUserProfileSectionCardContent, AXPUserProfileSectionComponentContent, AXPUserProfileSectionContent, AXPUserProfileSectionInsight, AXPUserProfileSectionLayout, AXPUserProfileSectionsPayload };