@masterteam/system-settings 0.0.17 → 0.0.18

package/types/masterteam-system-settings.d.ts

@@ -4,6 +4,8 @@ import * as _angular_core from '@angular/core';
 import { OnInit, InjectionToken, EnvironmentProviders } from '@angular/core';
 import { DatePicker } from 'primeng/datepicker';
 import { ModalService } from '@masterteam/components/modal';
+import { Observable } from 'rxjs';
+import * as _masterteam_system_settings from '@masterteam/system-settings';
 import { Routes } from '@angular/router';
 
 type SystemSettingPrimitive = string | number | boolean | null;
@@ -491,8 +493,12 @@ type EmailDeliveryPermission = (typeof EMAIL_DELIVERY_PERMISSIONS)[keyof typeof
 interface EmailDeliveryOptions {
     apiBasePath: string;
     notificationApiBasePath: string;
+    currentUserAccessibilitiesApiPath: string;
     permissionKeys: readonly string[];
 }
+interface EmailDeliveryAccessibility {
+    moduleKey: string;
+}
 interface EmailProviderAuthenticationModeDescriptor {
     key: string;
     displayName: string;
@@ -844,7 +850,209 @@ declare const DEFAULT_EMAIL_DELIVERY_OPTIONS: EmailDeliveryOptions;
 declare const EMAIL_DELIVERY_OPTIONS: InjectionToken<EmailDeliveryOptions>;
 declare function provideEmailDelivery(options?: Partial<EmailDeliveryOptions>): EnvironmentProviders;
 
+/**
+ * Resolves the signed-in user's real application accessibilities.
+ *
+ * `permissionKeys` describes which accessibility the feature requires; it is
+ * never a list of permissions granted to the user. The grant comes only from
+ * the authenticated `me/accessibilities` endpoint used by the host backend.
+ */
+declare class EmailDeliveryAccessService {
+    private readonly http;
+    private readonly options;
+    private request$;
+    readonly keys: _angular_core.WritableSignal<readonly string[]>;
+    readonly loading: _angular_core.WritableSignal<boolean>;
+    readonly loaded: _angular_core.WritableSignal<boolean>;
+    readonly error: _angular_core.WritableSignal<unknown>;
+    hasPermission(permission: EmailDeliveryPermission): boolean;
+    load(force?: boolean): Observable<readonly string[]>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<EmailDeliveryAccessService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<EmailDeliveryAccessService>;
+}
+
+declare function createEmailTestRequestId(): string;
+declare function parseEmailTestRecipients(value: string | null): string[];
+declare function areEmailTestRecipientsValid(value: unknown, maximumRecipients?: number, maximumAddressLength?: number): boolean;
+declare function collectEmailTemplatePlaceholders(...templates: Array<string | null | undefined>): string[];
+interface EmailTemplatePlaceholderProperty {
+    key: string;
+    name?: string | null;
+    nameEn?: string | null;
+    nameAr?: string | null;
+}
+interface EmailTemplatePlaceholderField {
+    key: string;
+    label: string;
+}
+/**
+ * Maps saved template keys to the localized labels returned by the property
+ * catalog while preserving the original keys used in test metadata.
+ */
+declare function buildEmailTemplatePlaceholderFields(keys: readonly string[], properties: readonly EmailTemplatePlaceholderProperty[], language?: string): EmailTemplatePlaceholderField[];
+declare function isEmailTestRequestPending(state: string): boolean;
+
+declare class EmailDeliveryFacade {
+    private readonly access;
+    private readonly api;
+    private readonly transloco;
+    private readonly toast;
+    private initialized;
+    private attemptsLoaded;
+    readonly status: _angular_core.WritableSignal<EmailDeliveryStatus | null>;
+    readonly providers: _angular_core.WritableSignal<EmailProviderDescriptor[]>;
+    readonly errorCatalog: _angular_core.WritableSignal<EmailErrorCatalogEntry[]>;
+    readonly connections: _angular_core.WritableSignal<EmailConnectionSummary[]>;
+    readonly selectedConnection: _angular_core.WritableSignal<EmailConnectionDetails | null>;
+    readonly attempts: _angular_core.WritableSignal<EmailDeliveryAttempt[]>;
+    readonly attemptsNextCursor: _angular_core.WritableSignal<string | null>;
+    readonly attemptStatusFilter: _angular_core.WritableSignal<string | null>;
+    readonly quarantine: _angular_core.WritableSignal<EmailFinalizationQuarantineItem[]>;
+    readonly quarantineNextCursor: _angular_core.WritableSignal<string | null>;
+    readonly hostEvidence: _angular_core.WritableSignal<EmailHostEvidenceItem[]>;
+    readonly hostEvidenceNextCursor: _angular_core.WritableSignal<string | null>;
+    readonly hostEvidenceScanBudgetExhausted: _angular_core.WritableSignal<boolean>;
+    readonly statusLoading: _angular_core.WritableSignal<boolean>;
+    readonly catalogLoading: _angular_core.WritableSignal<boolean>;
+    readonly connectionsLoading: _angular_core.WritableSignal<boolean>;
+    readonly detailsLoading: _angular_core.WritableSignal<boolean>;
+    readonly attemptsLoading: _angular_core.WritableSignal<boolean>;
+    readonly quarantineLoading: _angular_core.WritableSignal<boolean>;
+    readonly hostEvidenceLoading: _angular_core.WritableSignal<boolean>;
+    readonly mutationLoading: _angular_core.WritableSignal<string | null>;
+    readonly lastConnectionTest: _angular_core.WritableSignal<EmailSendResult | null>;
+    readonly lastConnectionTestRequestId: _angular_core.WritableSignal<string | null>;
+    readonly permissionsLoading: _angular_core.WritableSignal<boolean>;
+    readonly permissionsLoaded: _angular_core.WritableSignal<boolean>;
+    readonly permissionsError: _angular_core.WritableSignal<unknown>;
+    readonly activeConnection: _angular_core.Signal<EmailConnectionSummary | undefined>;
+    readonly managementAvailable: _angular_core.Signal<boolean>;
+    initialize(): void;
+    hasPermission(permission: EmailDeliveryPermission): boolean;
+    loadPermissions(force?: boolean): Observable<readonly string[]>;
+    loadStatus(): Observable<EmailDeliveryStatus>;
+    loadCatalog(): Observable<{
+        providers: EmailProviderDescriptor[];
+        errors: EmailErrorCatalogEntry[];
+    }>;
+    loadConnections(): Observable<EmailConnectionSummary[]>;
+    loadConnection(id: string): Observable<EmailConnectionDetails>;
+    createConnection(request: EmailConnectionCreateRequest): Observable<EmailConnectionDetails>;
+    updateConnection(id: string, request: EmailConnectionUpdateRequest): Observable<EmailConnectionDetails>;
+    deleteConnection(id: string, concurrencyToken: string): Observable<void>;
+    validateConnection(id: string): Observable<EmailConnectionValidationResult>;
+    sendConnectionTest(id: string, request: EmailConnectionTestRequest): Observable<EmailSendResult>;
+    retrieveConnectionTest(connectionId: string, testRequestId: string): Observable<EmailConnectionTestResult>;
+    sendTemplateTest(eventId: number, templateId: number, request: {
+        testRequestId: string;
+        emails: string[];
+        metadata: Record<string, string>;
+    }): Observable<EmailUserTestDispatchResult>;
+    sendAlertTest(alertId: number, request: {
+        testRequestId: string;
+        emails: string[];
+        metadata: Record<string, string>;
+    }): Observable<EmailUserTestDispatchResult>;
+    retrieveUserTest(testRequestId: string): Observable<EmailUserTestDispatchResult>;
+    bindConnection(id: string, purpose?: string): Observable<void>;
+    unbindConnection(id: string, purpose?: string): Observable<void>;
+    startAuthorization(id: string, kind: 'delegated' | 'admin-consent'): Observable<EmailAuthorizationStartResult>;
+    revokeAuthorization(id: string): Observable<void>;
+    loadAttempts(reset?: boolean, status?: string | null): Observable<_masterteam_system_settings.EmailAttemptPage>;
+    replayAttempt(attempt: EmailDeliveryAttempt, request: EmailAttemptReplayRequest): Observable<EmailAttemptReplayResult>;
+    loadQuarantine(reset?: boolean): Observable<_masterteam_system_settings.EmailFinalizationQuarantinePage>;
+    decideQuarantine(item: EmailFinalizationQuarantineItem, action: 'retry' | 'acknowledge', reason: string): Observable<EmailFinalizationQuarantineItem>;
+    loadHostEvidence(reset?: boolean): Observable<_masterteam_system_settings.EmailHostEvidencePage>;
+    exportHostEvidence(evidenceOccurrenceId: string): Observable<EmailEvidenceDownload>;
+    decideHostEvidence(item: EmailHostEvidenceItem, action: 'repair' | 'acknowledge', reason: string): Observable<EmailHostEvidenceItem>;
+    rebuildEvidenceIndex(take: number): Observable<EmailEvidenceRebuildResult>;
+    providerByKey(key: string | null | undefined): EmailProviderDescriptor | null;
+    describeCode(code: string | null | undefined): string;
+    /**
+     * The one sentence every failure path shows. It prefers the backend's stable
+     * code, falls back to the transport status the contract assigns a required
+     * behaviour to (401/403/409/422/428/429/503), and always appends the
+     * correlation ID when one is available — that identifier is what support asks
+     * for, and it is the only part of a failure this page is allowed to keep.
+     */
+    describeError(error: unknown): string;
+    errorAction(error: unknown): string | null;
+    showError(error: unknown): void;
+    /**
+     * A `409` means the server state moved under this page. The contract requires
+     * reloading it rather than re-submitting over it, so every mutation that can
+     * conflict routes through here: the latest connection, list and readiness are
+     * pulled back before the caller sees the rejection.
+     */
+    private reloadOnConflict;
+    private describeFailure;
+    private translateCode;
+    private translateStatus;
+    takePendingAuthorizationConnection(): string | null;
+    /**
+     * A completed controlled test writes its own Activity row, so the loaded
+     * Activity list is stale the moment the test returns. Only refresh once
+     * Activity has been opened — before that its own load covers it, and the
+     * status filter in effect there is preserved.
+     */
+    private refreshActivity;
+    private refreshConnection;
+    private rememberAuthorizationConnection;
+    private showSuccess;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<EmailDeliveryFacade, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<EmailDeliveryFacade>;
+}
+
+type EmailUserTestKind = 'template' | 'alert';
+interface MetadataControl {
+    key: string;
+    label: string;
+    control: FormControl<string>;
+}
+declare class EmailUserTestDialog {
+    readonly kind: _angular_core.InputSignal<EmailUserTestKind>;
+    readonly eventId: _angular_core.InputSignal<number | null>;
+    readonly templateId: _angular_core.InputSignal<number | null>;
+    readonly alertId: _angular_core.InputSignal<number | null>;
+    readonly sourceLabel: _angular_core.InputSignal<string>;
+    readonly placeholderKeys: _angular_core.InputSignal<readonly string[]>;
+    readonly placeholderFields: _angular_core.InputSignal<readonly EmailTemplatePlaceholderField[]>;
+    protected readonly modal: ModalService;
+    private readonly ref;
+    private readonly destroyRef;
+    private readonly transloco;
+    protected readonly facade: EmailDeliveryFacade;
+    protected readonly recipients: FormControl<string>;
+    protected readonly metadataControls: _angular_core.WritableSignal<MetadataControl[]>;
+    protected readonly testRequestId: _angular_core.WritableSignal<string>;
+    protected readonly timedOut: _angular_core.WritableSignal<boolean>;
+    protected readonly polling: _angular_core.WritableSignal<boolean>;
+    protected readonly result: _angular_core.WritableSignal<EmailUserTestDispatchResult | null>;
+    private pollIndex;
+    constructor();
+    protected canSubmit(): boolean;
+    protected submit(): void;
+    protected retrieve(): void;
+    protected close(): void;
+    private operation;
+    private hasValidTarget;
+    private acceptResult;
+    /**
+     * Retrieval in progress is not the same thing as a lost result. A `202` and a
+     * pending request state are the normal accepted path, so they only raise
+     * `polling`; `timedOut` is reserved for the poll budget running out or a
+     * retrieval that failed, which are the states that actually ask the operator
+     * to act.
+     */
+    private startPolling;
+    private schedulePoll;
+    private retrieveStoredResult;
+    protected t(key: string): string;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<EmailUserTestDialog, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<EmailUserTestDialog, "mt-email-user-test-dialog", never, { "kind": { "alias": "kind"; "required": true; "isSignal": true; }; "eventId": { "alias": "eventId"; "required": false; "isSignal": true; }; "templateId": { "alias": "templateId"; "required": false; "isSignal": true; }; "alertId": { "alias": "alertId"; "required": false; "isSignal": true; }; "sourceLabel": { "alias": "sourceLabel"; "required": false; "isSignal": true; }; "placeholderKeys": { "alias": "placeholderKeys"; "required": false; "isSignal": true; }; "placeholderFields": { "alias": "placeholderFields"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
 declare const EMAIL_DELIVERY_ROUTES: Routes;
 
-export { DEFAULT_DATE_FORMAT_OPTIONS, DEFAULT_EMAIL_DELIVERY_OPTIONS, DEFAULT_GENERAL_CONFIGURATION, DEFAULT_TIME_FORMAT_OPTIONS, DOTNET_DAY_DEFINITIONS, EMAIL_DELIVERY_ATTEMPT_STATUSES, EMAIL_DELIVERY_OPTIONS, EMAIL_DELIVERY_PERMISSIONS, EMAIL_DELIVERY_ROUTES, EMAIL_USER_INITIATED_TEST_OPERATION_KIND, EXPLORE_DEFAULT_VIEW_OPTIONS, FIXED_CURRENCIES, GENERAL_CONFIGURATION_SETTING_KEY, RATE_SOURCE_OPTIONS, SCHEDULE_ITEM_TYPE_OPTIONS, SystemSettings, SystemSettingsHolidayEditor, TIMESHEET_FREQUENCY_OPTIONS, WEEKEND_DAY_DEFINITIONS, isConnectionTestAttempt, provideEmailDelivery };
-export type { ApiResponse, AppResponse, CurrencyCatalogItem, CurrencySettingValue, CurrencyUnitLabel, EmailAttemptPage, EmailAttemptReplayRequest, EmailAttemptReplayResult, EmailAuthorizationStartResult, EmailConnectionCreateRequest, EmailConnectionDetails, EmailConnectionRecord, EmailConnectionSummary, EmailConnectionTestRequest, EmailConnectionTestResult, EmailConnectionUpdateRequest, EmailConnectionValidationResult, EmailCredentialMutation, EmailCredentialOperation, EmailCredentialStatus, EmailCredentialStorageKind, EmailDeliveryAttempt, EmailDeliveryOptions, EmailDeliveryPermission, EmailDeliveryProblem, EmailDeliveryStatus, EmailErrorCatalogEntry, EmailEvidenceDecisionRequest, EmailEvidenceDownload, EmailEvidenceRebuildResult, EmailFinalizationQuarantineItem, EmailFinalizationQuarantinePage, EmailHostEvidenceItem, EmailHostEvidencePage, EmailProviderActionDescriptor, EmailProviderAuthenticationModeDescriptor, EmailProviderDescriptor, EmailProviderFieldDescriptor, EmailSafeDiagnostic, EmailSendResult, EmailUserTestDispatchResult, ExploreDefaultView, FormatSchemaOption, GeneralConfigurationSettingValue, GlobalWorkingHoursSettingValue, HolidayItem, HolidayTableRow, HolidaysSettingValue, IconSelectOption, ScheduleItemTypeOption, SelectOption, SystemSetting, SystemSettingObject, SystemSettingPrimitive, SystemSettingValue, SystemSettingsForm, SystemSettingsFormatSchema, SystemSettingsSnapshot, TimeSheetFrequency, TimeSheetPolicySettingValue, TimezoneRegionOption, TimezoneSettingValue, UpdateSystemSettingItem, WeekendDayOption, WeekendSettingValue };
+export { DEFAULT_DATE_FORMAT_OPTIONS, DEFAULT_EMAIL_DELIVERY_OPTIONS, DEFAULT_GENERAL_CONFIGURATION, DEFAULT_TIME_FORMAT_OPTIONS, DOTNET_DAY_DEFINITIONS, EMAIL_DELIVERY_ATTEMPT_STATUSES, EMAIL_DELIVERY_OPTIONS, EMAIL_DELIVERY_PERMISSIONS, EMAIL_DELIVERY_ROUTES, EMAIL_USER_INITIATED_TEST_OPERATION_KIND, EXPLORE_DEFAULT_VIEW_OPTIONS, EmailDeliveryAccessService, EmailUserTestDialog, FIXED_CURRENCIES, GENERAL_CONFIGURATION_SETTING_KEY, RATE_SOURCE_OPTIONS, SCHEDULE_ITEM_TYPE_OPTIONS, SystemSettings, SystemSettingsHolidayEditor, TIMESHEET_FREQUENCY_OPTIONS, WEEKEND_DAY_DEFINITIONS, areEmailTestRecipientsValid, buildEmailTemplatePlaceholderFields, collectEmailTemplatePlaceholders, createEmailTestRequestId, isConnectionTestAttempt, isEmailTestRequestPending, parseEmailTestRecipients, provideEmailDelivery };
+export type { ApiResponse, AppResponse, CurrencyCatalogItem, CurrencySettingValue, CurrencyUnitLabel, EmailAttemptPage, EmailAttemptReplayRequest, EmailAttemptReplayResult, EmailAuthorizationStartResult, EmailConnectionCreateRequest, EmailConnectionDetails, EmailConnectionRecord, EmailConnectionSummary, EmailConnectionTestRequest, EmailConnectionTestResult, EmailConnectionUpdateRequest, EmailConnectionValidationResult, EmailCredentialMutation, EmailCredentialOperation, EmailCredentialStatus, EmailCredentialStorageKind, EmailDeliveryAccessibility, EmailDeliveryAttempt, EmailDeliveryOptions, EmailDeliveryPermission, EmailDeliveryProblem, EmailDeliveryStatus, EmailErrorCatalogEntry, EmailEvidenceDecisionRequest, EmailEvidenceDownload, EmailEvidenceRebuildResult, EmailFinalizationQuarantineItem, EmailFinalizationQuarantinePage, EmailHostEvidenceItem, EmailHostEvidencePage, EmailProviderActionDescriptor, EmailProviderAuthenticationModeDescriptor, EmailProviderDescriptor, EmailProviderFieldDescriptor, EmailSafeDiagnostic, EmailSendResult, EmailTemplatePlaceholderField, EmailTemplatePlaceholderProperty, EmailUserTestDispatchResult, EmailUserTestKind, ExploreDefaultView, FormatSchemaOption, GeneralConfigurationSettingValue, GlobalWorkingHoursSettingValue, HolidayItem, HolidayTableRow, HolidaysSettingValue, IconSelectOption, ScheduleItemTypeOption, SelectOption, SystemSetting, SystemSettingObject, SystemSettingPrimitive, SystemSettingValue, SystemSettingsForm, SystemSettingsFormatSchema, SystemSettingsSnapshot, TimeSheetFrequency, TimeSheetPolicySettingValue, TimezoneRegionOption, TimezoneSettingValue, UpdateSystemSettingItem, WeekendDayOption, WeekendSettingValue };