@sunbird-cb/utils-v2 0.0.1

package/lib/services/auth-keycloak.service.d.ts

@@ -0,0 +1,31 @@
+import { HttpClient } from '@angular/common/http';
+import { KeycloakService } from 'keycloak-angular';
+import { AuthMicrosoftService } from './auth-microsoft.service';
+import { ConfigurationsService } from './configurations.service';
+export declare class AuthKeycloakService {
+    private http;
+    private configSvc;
+    private keycloakSvc;
+    private msAuthSvc;
+    private loginChangeSubject;
+    constructor(http: HttpClient, configSvc: ConfigurationsService, keycloakSvc: KeycloakService, msAuthSvc: AuthMicrosoftService);
+    readonly isLoggedIn$: import("rxjs").Observable<boolean>;
+    readonly isLoggedIn: Promise<boolean>;
+    readonly isAuthenticated: boolean | undefined;
+    readonly token: string | undefined;
+    readonly sessionId: string | undefined;
+    readonly userId: string | undefined;
+    readonly userEmail: string | undefined;
+    readonly userName: string | undefined;
+    initAuth(): Promise<boolean>;
+    login(idpHint?: 'E' | 'N' | 'S', redirectUrl?: string): Promise<void>;
+    loginV2(_idpHint?: 'E' | 'N' | 'S', redirectUrl?: string): Promise<void>;
+    register(redirectUrl?: string): Promise<void>;
+    logout(redirectUrl?: string): Promise<void>;
+    force_logout(): Promise<void>;
+    private addKeycloakEventListener;
+    private setupGlobalAuthResponder;
+    private saveKeycloakConfig;
+    private getSavedKcConfig;
+    private readonly defaultRedirectUrl;
+}

package/lib/services/auth-microsoft.service.d.ts

@@ -0,0 +1,30 @@
+import { LoggerService } from './logger.service';
+import { NsInstanceConfig } from './configurations.model';
+import { HttpClient } from '@angular/common/http';
+import { IWsMsTokenModelResponse } from './ms-office.model';
+export declare class AuthMicrosoftService {
+    private loggerSvc;
+    private http;
+    private msConfig;
+    private emailUsed;
+    private code;
+    private msToken;
+    constructor(loggerSvc: LoggerService, http: HttpClient);
+    readonly isLogoutRequired: boolean;
+    readonly loginUrl: string | null;
+    logoutUrl(redirectUrl: string): string;
+    init(config: Pick<NsInstanceConfig.IConfig, 'microsoft'>): Promise<void>;
+    login(email: string): Promise<void>;
+    getToken(email: string): Promise<string>;
+    loginForSSOEnabledEmbed(email: string): void;
+    isValidEmail(email: string): boolean;
+    isValid(accessToken: string | undefined, expiresOn: string | undefined): boolean;
+    exchangeTokenForCode(code: string, redirectUrl: string): Promise<any>;
+    getTokenForEmail(email: string): Promise<any>;
+    getInstanceFromResponse(token: IWsMsTokenModelResponse): {
+        accessToken: string | undefined;
+        expiresOn: string | undefined;
+        resource: string | undefined;
+        tokenType: string | undefined;
+    };
+}

package/lib/services/card-content.model.d.ts

@@ -0,0 +1,29 @@
+import { NsContent } from '../services/widget-content.model';
+export declare namespace NsCardContent {
+    interface ICard {
+        content: NsContent.IContent;
+        cardSubType: TCardSubType;
+        context: {
+            pageSection: string;
+            position?: number;
+        };
+        intranetMode?: 'greyOut' | 'hide';
+        deletedMode?: 'greyOut' | 'hide';
+        likes?: number;
+        contentTags?: IContentTags;
+    }
+    interface IContentTags {
+        daysSpan?: number;
+        excludeContentType?: NsContent.EContentTypes[];
+        excludeMimeType?: string[];
+        tag: string;
+        criteriaField?: string;
+    }
+    type TCardSubType = 'standard' | 'minimal' | 'space-saving' | 'card-user-details' | 'basic-info' | 'basic-details' | 'card-description-back' | 'network-card';
+    enum EContentStatus {
+        LIVE = "Live",
+        EXPIRED = "Expired",
+        DELETED = "Deleted",
+        MARK_FOR_DELETION = "MarkedForDeletion"
+    }
+}

package/lib/services/configurations.model.d.ts

@@ -0,0 +1,521 @@
+import { NsPage } from '../resolvers/page.model';
+import { NsWidgetResolver } from './widget-resolver.model';
+export declare namespace NsInstanceConfig {
+    interface IConfig {
+        authoring: {
+            doUniqueCheck: boolean;
+            isMultiStepFlow: boolean;
+            allowExpiry: boolean;
+            allowRestore: boolean;
+            allowReview: boolean;
+            allowPublish: boolean;
+            allowRedo: boolean;
+            newDesign: boolean;
+            allowedContentType: string[];
+            urlPatternMatching: {
+                allowReplace: boolean;
+                source: string;
+                pattern: string;
+                allowIframe: boolean;
+            }[];
+        };
+        appSetup: boolean;
+        chatBotUrl: string;
+        defaultFontsize: string;
+        defaultThemeClass: string;
+        defaultLocale: string;
+        disablePidCheck?: boolean;
+        isMultilingualEnabled?: boolean;
+        fontSizes: IFontSize[];
+        isContentDownloadAvailable: boolean;
+        indexHtmlMeta: IIndexHtmlMeta;
+        keycloak: IKeycloak;
+        locals: ILocalsConfig[];
+        microsoft: IMicrosoft;
+        telemetryConfig: ITelemetryConfig;
+        themes: ITheme[];
+        logos: ILogos;
+        sources?: ISourceLogo[];
+        mailIds: IMailIds;
+        details: IDetails;
+        validMailIdExtensionsForMailMe: string[];
+        overrideThemeChanges: IOverrideThemeChanges;
+        defaultFeatureConfigs: {
+            error: string;
+        };
+        backgrounds: {
+            primaryNavBar: NsPage.INavBackground;
+            pageNavBar: NsPage.INavBackground;
+        };
+        featuredApps: string[];
+        primaryNavBarConfig: IPrimaryNavbarConfig;
+        org: string[];
+        rootOrg: string;
+        intranetIframeUrls?: string[];
+        showNavBarInSetup?: boolean;
+        intranetUrlToCheck?: string;
+        introVideo: IPath;
+        tourVideo: IPath;
+        isDownloadableSource?: IPath;
+        isDownloadableIosResource?: IPath;
+        isDownloadableAndroidResource?: IPath;
+        sourceFieldsUserAutocomplete?: string[];
+        forgotPasswordConfig?: IForgotPassword;
+        hubs: IHubs[];
+        courseContentPath?: string;
+        portalUrls: IPortalUrls | undefined;
+        positions: any;
+        websitelanguages: any[];
+        profileTimelyNudges: any;
+    }
+    interface IPortalUrls {
+        igot: string;
+        spv: string;
+        mdo: string;
+        cbc: string;
+        cbp: string;
+        frac: string;
+    }
+    interface IForgotPassword {
+        local?: string;
+        enterprise?: string;
+        social?: string;
+    }
+    interface ISourceLogo {
+        sourceName?: string;
+        sourceId?: string;
+        logo?: string;
+    }
+    interface IPath {
+        [key: string]: string;
+    }
+    interface IHubs {
+        active: boolean;
+        desc: string;
+        hubname: string;
+        icon: string;
+        path: string;
+        order: number;
+    }
+    interface IIndexHtmlMeta {
+        description?: string;
+        openSearchUrl?: string;
+        webmanifest: string;
+        xIcon?: string;
+        pngIcon?: string;
+    }
+    interface IFontSize {
+        baseFontSize: string;
+        fontClass: string;
+        scale: number;
+    }
+    interface IKeycloak {
+        defaultidpHint: 'E' | 'N' | 'S';
+        isLoginHidden: boolean;
+        bearerExcludedUrls: string[];
+        clientId: string;
+        key: string;
+        realm: string;
+        url: string;
+        changePasswordUrl?: string;
+        onLoad?: 'check-sso' | 'login-required';
+    }
+    interface ILocalsConfig {
+        isAvailable: boolean;
+        isEnabled: boolean;
+        locals: string[];
+        path: string;
+        isRTL: boolean;
+    }
+    interface IMicrosoft {
+        clientId: string;
+        defaultEmailId: string;
+        tenant: string;
+        validEmailExtensions: string[];
+        isConfigured: boolean;
+    }
+    interface ITheme {
+        color: IThemeColor;
+        themeFile: string;
+        themeClass: string;
+        themeName: string;
+    }
+    interface IThemeColor {
+        accent: string;
+        primary: string;
+        warn: string;
+    }
+    interface IOverrideThemeChanges {
+        isEnabled: boolean;
+        desktop: IDesktop;
+        mWeb: IMWeb;
+    }
+    interface IDesktop {
+        animationDuration: number;
+        logoUrl: string;
+        logoText: string;
+        logoDisplayTime: number;
+        backgroundTheme: string;
+    }
+    interface IMWeb {
+        logoUrl: string;
+        logoText: string;
+    }
+    interface ILogos {
+        app: string;
+        appTransparent: string;
+        appSecondary: string;
+        aboutFooter: string;
+        aboutHeader: string;
+        appBottomNav?: string;
+        company: string;
+        developedBy: string;
+        poweredBy: string;
+        defaultContent?: string;
+        defaultSourceLogo?: string;
+        landingLogo: string;
+        navbarLogo?: string;
+        playListLogo?: string;
+        thumpsUp?: string;
+    }
+    interface IMailIds {
+        contactUs: string;
+        default: string;
+        support: string;
+    }
+    interface IDetails {
+        appName: string;
+    }
+    interface IPrimaryNavbarConfig {
+        mediumScreen: IPrimaryNavBarScreen;
+        smallScreen: IPrimaryNavBarScreen;
+    }
+    interface IPrimaryNavBarScreen {
+        left: IPrimaryNavBarSide[];
+        right: IPrimaryNavBarSide[];
+    }
+    interface IPrimaryNavBarSide {
+        type: 'widgetButton' | 'featureButton';
+        config: NsWidgetResolver.IRenderConfigWithAnyData | NsPage.INavLink;
+    }
+    interface ITelemetryConfig {
+        pdata: {
+            id: string;
+            ver: string;
+            pid: string;
+        };
+        object: {
+            ver: string;
+            id: string | undefined;
+        };
+        uid: string | null;
+        authtoken?: string;
+        env: string;
+        channel: string;
+        batchsize: number;
+        host: string;
+        endpoint: string;
+        apislug: string;
+        sid: string;
+        publicEndpoint: string;
+        protectedEndpoint: string;
+    }
+}
+export declare namespace NsAppsConfig {
+    type TIconType = 'mat-icon' | 'url';
+    interface IAppsConfig {
+        groups: IGroup[];
+        features: {
+            [id: string]: IFeature;
+        };
+        tourGuide?: string[][];
+    }
+    interface IGroup {
+        id: string;
+        iconType: string;
+        icon: string;
+        keywords: string[];
+        name: string;
+        toolTip: string;
+        featureIds: string[];
+        stripBackground?: string;
+        hasRole: string[];
+    }
+    interface IFeature {
+        name: string;
+        id: string;
+        url: string;
+        permission: string | string[] | {
+            all: string[];
+            some: string[];
+            none: string[];
+        };
+        iconType: TIconType;
+        icon: string;
+        keywords: string[];
+        toolTip: string;
+        accessKey: string;
+        status?: 'earlyAccess' | 'live' | 'alpha' | 'beta';
+        shortName: string;
+        description?: string;
+        badgeEndpoint?: string;
+        mobileAppFunction?: string;
+        color?: string;
+        target?: string;
+    }
+}
+export declare namespace NsUser {
+    interface IUserProfile {
+        userId: string;
+        email?: string;
+        departmentName?: string;
+        userName?: string;
+        firstName?: string;
+        surName?: string;
+        middleName?: string;
+        lastName?: string;
+        rootOrgId?: string;
+        rootOrgName?: string;
+        profileImage?: string;
+        givenName?: string;
+        country?: null | string;
+        unit?: string | null;
+        source_profile_picture?: null | string;
+        dealerCode?: null | string;
+        isManager?: boolean;
+        competencies?: any;
+        systemTopics?: any;
+        desiredTopics?: any;
+        desiredCompetencies?: any;
+        userRoles?: any;
+        profileUpdateCompletion?: number;
+        profileImageUrl?: string;
+        professionalDetails?: any;
+        webPortalLang?: any;
+    }
+    interface INodebbUserProfile {
+        username: string;
+        email: string;
+    }
+    interface IUserPidProfile {
+        kid_updated: boolean;
+        user: IUser;
+    }
+    interface IUserPidProfileV2 {
+        kid_updated: boolean;
+        result: {
+            response: IUserV2;
+        };
+    }
+    interface IUserPidProfileVer2 {
+        result: {
+            UserProfile: IUserVer2;
+        };
+    }
+    interface ISourceData {
+        GID: string;
+        SNAMPRE: string;
+        SNAMADD: string;
+        LASTNAME: string;
+        SN: string;
+        GIVENNAME: string;
+        NICKNAME: string;
+        PREFERREDSN: string;
+        PERSONALTITLE: string;
+        MOBILE: string;
+        MAIL: string;
+        DEPARTMENTTEXT: string;
+        COSTLOCATIONUNIT: string;
+        COSTLOCATION: string;
+        ORGID: string;
+        MGMTRESP: string;
+        UTC: string;
+        CNAMEENG: string;
+        LNAMEINT: string;
+        USERTYPE: string;
+        STATUS: string;
+        CONTRACTSTATUS: string;
+    }
+    interface IUser {
+        wid: string;
+        root_org: string;
+        org: string;
+        is_active?: any;
+        account_expiry_date?: any;
+        kid: string;
+        imported_source_name: string;
+        source_id: string;
+        username?: any;
+        first_name: string;
+        last_name: string;
+        middle_name?: any;
+        known_as: string;
+        salutation?: any;
+        email: string;
+        gender?: any;
+        dob?: any;
+        languages_known?: any;
+        preferred_language?: any;
+        source_profile_picture?: any;
+        residence_country: string;
+        residence_state?: any;
+        residence_city: string;
+        contact_phone_number_office?: any;
+        contact_phone_number_home?: any;
+        contact_phone_number_personal: string;
+        employement_status?: any;
+        contract_type?: any;
+        job_title?: any;
+        job_role?: any;
+        department_name: string;
+        unit_name?: any;
+        organization_location_country?: any;
+        organization_location_state?: any;
+        organization_location_city?: any;
+        time_inserted: Date;
+        time_updated: Date;
+        json_unmapped_fields?: any;
+        source_data: ISourceData;
+    }
+    interface IRootOrg {
+        dateTime: string;
+        preferredLanguage: string;
+        keys: {};
+        channel: string;
+        approvedBy: string;
+        description: string;
+        updatedDate: string;
+        addressId: string;
+        orgType: string;
+        provider: string;
+        orgCode: string;
+        locationId: string;
+        theme: string;
+        id: string;
+        isApproved: boolean;
+        communityId: string;
+        slug: string;
+        email: string;
+        isSSOEnabled: boolean;
+        thumbnail: string;
+        updatedBy: string;
+        orgName: string;
+        locationIds: [];
+        externalId: string;
+        isRootOrg: boolean;
+        rootOrgId: string;
+        imgUrl: string;
+        approvedDate: string;
+        orgTypeId: string;
+        homeUrl: string;
+        isDefault: boolean;
+        createdDate: string;
+        contactDetail: string;
+        parentOrgId: string;
+        createdBy: string;
+        hashTagId: string;
+        noOfMembers: string;
+        status: number;
+    }
+    interface IOrg {
+        updatedBy: string;
+        organisationId: string;
+        orgName: string;
+        addedByName: string;
+        addedBy: string;
+        roles: string[];
+        approvedBy: string;
+        updatedDate: string;
+        userId: string;
+        approvaldate: string;
+        isDeleted: boolean;
+        parentOrgId: string;
+        hashTagId: string;
+        isRejected: boolean;
+        position: string;
+        id: string;
+        orgjoindate: string;
+        isApproved: boolean;
+        orgLeftDate: string;
+    }
+    interface IUserV2 {
+        surName: any;
+        maskedPhone: string;
+        rootOrgName: string;
+        subject: [];
+        channel: string;
+        language: [];
+        updatedDate: string;
+        managedBy: string;
+        flagsValue: number;
+        id: string;
+        recoveryEmail: string;
+        identifier: string;
+        thumbnail: string;
+        profileVisibility: [];
+        updatedBy: string;
+        accesscode: string;
+        locationIds: [];
+        externalIds: [];
+        registryId: string;
+        rootOrgId: string;
+        prevUsedEmail: string;
+        firstName: string;
+        tncAcceptedOn: string;
+        phone: string;
+        dob: string;
+        grade: [];
+        currentLoginTime: string;
+        userType: string;
+        status: number;
+        lastName: string;
+        gender: string;
+        roles: string[];
+        prevUsedPhone: string;
+        stateValidated: boolean;
+        isDeleted: boolean;
+        organisations: IOrg[];
+        countryCode: string;
+        maskedEmail: string;
+        tempPassword: string;
+        email: string;
+        rootOrg: IRootOrg;
+        profileSummary: string;
+        phoneVerified: boolean;
+        recoveryPhone: string;
+        userName: string;
+        userId: string;
+        lastLoginTime: string;
+        emailVerified: true;
+        framework: {};
+        createdDate: string;
+        createdBy: string;
+        location: string;
+        tncAcceptedVersion: string;
+    }
+    interface IUserVer2 {
+        'firstname': string;
+        'motherTongue': string;
+        'secondaryEmail': string;
+        'gender': string;
+        '@type': string;
+        'mobile': number;
+        'middlename': string;
+        'telephone': number;
+        'osid': string;
+        'primaryEmailType': string;
+        'knownLanguages': ILanguages[];
+        'wid': string;
+        'nationality': string;
+        'surname': string;
+        'dob': string;
+        'category': string;
+        'primaryEmail': string;
+        'maritalStatus': string;
+        'residenceAddress': string;
+        'result': any;
+    }
+    interface ILanguages {
+        name: string;
+    }
+}

package/lib/services/configurations.service.d.ts

@@ -0,0 +1,73 @@
+import { NSProfileDataV3 } from '../models/profile-v3.models';
+import { BehaviorSubject, ReplaySubject, Subject } from 'rxjs';
+import { NsPage } from '../resolvers/page.model';
+import { NsAppsConfig, NsInstanceConfig, NsUser } from './configurations.model';
+import { IPortalUrls, IUserPreference } from './user-preference.model';
+export declare class ConfigurationsService {
+    constructor();
+    appSetup: boolean;
+    userUrl: string;
+    baseUrl: string;
+    sitePath: string;
+    hostPath: string;
+    userRoles: Set<string> | null;
+    userGroups: Set<string> | null;
+    restrictedFeatures: Set<string> | null;
+    restrictedWidgets: Set<string> | null;
+    instanceConfig: NsInstanceConfig.IConfig | null;
+    appsConfig: NsAppsConfig.IAppsConfig | null;
+    rootOrg: string | null;
+    courseContentPath?: string;
+    org: string[] | null;
+    activeOrg: string | null;
+    isProduction: boolean;
+    hasAcceptedTnc: boolean;
+    profileDetailsStatus: boolean;
+    isActive: boolean;
+    userPreference: IUserPreference | null;
+    userProfile: NsUser.IUserProfile | null;
+    userProfileV2: NsUser.IUserProfile | null;
+    nodebbUserProfile: NsUser.INodebbUserProfile | null;
+    unMappedUser: any;
+    isAuthenticated: boolean;
+    isNewUser: boolean;
+    portalUrls: IPortalUrls | undefined;
+    positions: any;
+    overrideThemeChanges: any;
+    profileTimelyNudges: any;
+    pinnedApps: BehaviorSubject<Set<string>>;
+    prefChangeNotifier: ReplaySubject<Partial<IUserPreference>>;
+    tourGuideNotifier: ReplaySubject<boolean>;
+    authChangeNotifier: ReplaySubject<boolean>;
+    private updateProfile;
+    updateProfileObservable: import("rxjs").Observable<boolean>;
+    updateTourGuide: BehaviorSubject<boolean>;
+    updateTourGuideObservable: import("rxjs").Observable<boolean>;
+    updatePlatformRating: BehaviorSubject<{
+        bottom: string;
+    }>;
+    updatePlatformRatingObservable$: import("rxjs").Observable<{
+        bottom: string;
+    }>;
+    languageTranslationFlag: Subject<unknown>;
+    activeThemeObject: NsInstanceConfig.ITheme | null;
+    activeFontObject: NsInstanceConfig.IFontSize | null;
+    isDarkMode: boolean;
+    isIntranetAllowed: boolean;
+    isRTL: boolean;
+    activeLocale: NsInstanceConfig.ILocalsConfig | null;
+    activeLocaleGroup: string;
+    completedActivity: string[] | null;
+    completedTour: boolean;
+    profileSettings: string[];
+    primaryNavBar: Partial<NsPage.INavBackground>;
+    pageNavBar: Partial<NsPage.INavBackground>;
+    primaryNavBarConfig: NsInstanceConfig.IPrimaryNavbarConfig | null;
+    welcomeTabs: NSProfileDataV3.IProfileTab | null;
+    cstoken: string;
+    changeNavBarFullView: Subject<unknown>;
+    openExploreMenuForMWeb: Subject<unknown>;
+    updateGlobalProfile(state: boolean): void;
+    updateTourGuideMethod(state: boolean): void;
+    updatePlatformRatingMethod(state: any): void;
+}