@sunbird-cb/utils-v2 0.0.0-watch

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

@@ -0,0 +1,356 @@
+export declare namespace NsContent {
+    export interface IContinueLearningData extends IContent {
+        continueData: any;
+    }
+    export interface IContent {
+        platform?: any;
+        addedOn: string;
+        appIcon: string;
+        artifactUrl: string;
+        averageRating?: any;
+        body?: string;
+        certificationList?: IRelatedContentMeta[];
+        certificationStatus?: TCertificationStatus;
+        certificationSubmissionDate?: string;
+        certificationUrl: string;
+        children: IContent[];
+        childrenClassifiers?: string[];
+        clients?: IClient[];
+        collections?: IContent[];
+        complexityLevel: string;
+        contentId: string;
+        contentType: EContentTypes;
+        difficultyLevel: string;
+        primaryCategory: EPrimaryCategory;
+        contentUrlAtSource: string;
+        creatorContacts: ICreator[];
+        creatorDetails: ICreator[];
+        creatorLogo: string;
+        creatorPosterImage: string;
+        creatorThumbnail: string;
+        curatedTags: string[];
+        description: string;
+        displayContentType: EDisplayContentTypes;
+        downloadUrl?: string;
+        duration: number;
+        exclusiveContent?: boolean;
+        expiryDate?: string;
+        equivalentCertifications?: IRelatedContentMeta[];
+        hasAccess: boolean;
+        hasAssessment?: string;
+        idealScreenSize?: string;
+        identifier: string;
+        introductoryVideo?: string;
+        introductoryVideoIcon?: string;
+        learningTrack?: string;
+        isExternal: boolean;
+        isIframeSupported: 'Yes' | 'No' | 'Maybe';
+        isInIntranet?: boolean;
+        keywords?: string[];
+        kArtifacts?: IRelatedContentMeta[];
+        lastUpdatedOn: string;
+        learningMode?: TLearningMode;
+        learningObjective: string;
+        labels?: string[];
+        locale?: string;
+        hasTranslations?: {
+            identifier: string;
+            locale: string;
+        }[];
+        isTranslationOf?: {
+            identifier: string;
+            locale: string;
+        }[];
+        me_totalSessionsCount: number;
+        mediaType: string;
+        mimeType: EMimeTypes;
+        miniGOTVersion?: string;
+        msArtifactDetails?: IMSArtifactDetails;
+        mode?: ETagType;
+        name: string;
+        nextCertificationAttemptDate?: string;
+        playgroundInstructions?: string;
+        playgroundResources?: IResourcePlayground[];
+        postContents?: IPrePostContent[];
+        posterImage?: string;
+        preContents?: IPrePostContent[];
+        preRequisites: string;
+        price?: {
+            currency: string;
+            value: number;
+        };
+        proctorUrl?: string;
+        progress?: IMarkAsCompleteProgress;
+        programDuration?: any;
+        publishedOn: string;
+        recentCertificationAttemptScore?: number;
+        recommendationReasons?: string[];
+        region?: string[];
+        registrationUrl?: string;
+        registrationInstructions?: string;
+        resourceCategory?: string[];
+        resourceType: string;
+        size?: number;
+        skills: ISkill[];
+        softwareRequirements?: IResourceDetail[];
+        sourceName: string;
+        sourceShortName: string;
+        sourceIconUrl?: string;
+        sourceUrl?: string;
+        ssoEnabled?: boolean;
+        status: 'Draft' | 'InReview' | 'QualityReview' | 'Reviewed' | 'Processing' | 'Live' | 'Deleted' | 'MarkedForDeletion' | 'Expired';
+        subTitle?: string;
+        subTitles?: ISubtitle[];
+        studyMaterials?: IRelatedContentMeta[];
+        systemRequirements?: string[];
+        tags: ITag[];
+        topics: IContentTopic[];
+        totalLikes?: {
+            [key: string]: number;
+        };
+        totalRating?: number;
+        track: ITrack[];
+        uniqueLearners?: number;
+        viewCount?: {
+            [key: string]: number;
+        };
+        reason?: string;
+        trainingLHubCount?: number;
+        verifiers?: {
+            name: string;
+            email: string;
+            id: string;
+        }[];
+        references?: {
+            url: string;
+            title: string;
+        }[];
+        resumePage?: number;
+        [key: string]: any;
+        optionalReading: boolean;
+        additionalTags?: string[];
+    }
+    export enum EPrimaryCategory {
+        PROGRAM = "Program",
+        COURSE = "Course",
+        MODULE = "Course Unit",
+        RESOURCE = "Learning Resource",
+        GOALS = "GOALS",
+        PRACTICE_RESOURCE = "Practice Question Set",
+        FINAL_ASSESSMENT = "Course Assessment",
+        COMP_ASSESSMENT = "Competency Assessment",
+        FTB_QUESTION = "FTB Question",
+        MTF_QUESTION = "MTF Question",
+        MULTIPLE_CHOICE_QUESTION = "Multiple Choice Question",
+        SINGLE_CHOICE_QUESTION = "Single Choice Question",
+        MANDATORY_COURSE_GOAL = "Mandatory Course Goal",
+        BLENDED_PROGRAM = "Blended Program",
+        OFFLINE_SESSION = "Offline Session",
+        KNOWLEDGE_ARTIFACT = "Knowledge Artifact",
+        KNOWLEDGE_BOARD = "Knowledge Board",
+        LEARNING_JOURNEY = "Learning Journeys",
+        CHANNEL = "Channel"
+    }
+    export interface IContentMinimal {
+        appIcon: string;
+        artifactUrl: string;
+        complexityLevel: string;
+        contentType: EContentTypes;
+        primaryCategory: EPrimaryCategory;
+        description: string;
+        displayContentType?: EDisplayContentTypes;
+        duration: number;
+        identifier: string;
+        hasAccess?: boolean;
+        isInIntranet?: boolean;
+        learningMode?: TLearningMode;
+        mimeType: EMimeTypes;
+        name: string;
+        creatorDetails: ICreator[];
+        creatorContacts: ICreator[];
+        PosterImage?: string;
+        resourceType?: string;
+        totalRating?: number;
+    }
+    export interface ICollectionHierarchyResponse {
+        data: IContent;
+        hasMore: boolean;
+        totalContents: number;
+    }
+    export interface IRelatedContentMeta {
+        identifier: string;
+        name: string;
+    }
+    type TCertificationStatus = 'ongoing' | 'passed' | 'canAttempt' | 'cannotAttempt';
+    export type TLearningMode = 'Self-Paced' | 'Instructor-Led' | 'Open' | 'Closed';
+    interface IMarkAsCompleteProgress {
+        progressStatus: 'open' | 'started' | 'completed';
+        showMarkAsComplete: boolean;
+        markAsCompleteReason: string;
+        progressSupported: boolean;
+        progress: number | null;
+    }
+    interface ITag {
+        id: string;
+        type: string;
+        value: string;
+    }
+    interface IMSArtifactDetails {
+        channelId: string;
+        videoId: string;
+    }
+    interface IClient {
+        displayName: string;
+        id: string;
+        name: string;
+    }
+    interface ISubtitle {
+        srclang: string;
+        label: string;
+        url: string;
+    }
+    interface IPrePostContent {
+        identifier: string;
+        name: string;
+    }
+    interface IResourceDetail {
+        title?: string;
+        url?: string;
+    }
+    interface IResourcePlayground {
+        appIcon: string;
+        artifactUrl: string;
+        identifier: string;
+        name: string;
+    }
+    interface ITrack {
+        id: string;
+        name: string;
+        status: string;
+        visibility: string;
+    }
+    interface ISkill {
+        id: string;
+        category: string;
+        skill: string;
+        name: string;
+    }
+    export interface ICreator {
+        id: string;
+        name: string;
+        email: string;
+    }
+    export interface IContentTopic {
+        identifier: string;
+        name: string;
+    }
+    export interface IContact {
+        id: string;
+        name: string;
+        email: string;
+    }
+    export interface IViewerContinueLearningRequest {
+        resourceId: string;
+        contextPathId: string;
+        data: string;
+        dateAccessed: number;
+        contextType?: string;
+    }
+    export enum EContentTypes {
+        PROGRAM = "Learning Path",
+        CHANNEL = "Channel",
+        COURSE = "Course",
+        KNOWLEDGE_ARTIFACT = "Knowledge Artifact",
+        KNOWLEDGE_BOARD = "Knowledge Board",
+        LEARNING_JOURNEY = "Learning Journeys",
+        MODULE = "Collection",
+        RESOURCE = "Resource"
+    }
+    export enum EMiscPlayerSupportedCollectionTypes {
+        PLAYLIST = "Playlist"
+    }
+    export const PLAYER_SUPPORTED_COLLECTION_TYPES: string[];
+    export const KB_SUPPORTED_CONTENT_TYPES: EContentTypes[];
+    export const PLAYLIST_SUPPORTED_CONTENT_TYPES: EContentTypes[];
+    export enum EMimeTypes {
+        COLLECTION = "application/vnd.ekstep.content-collection",
+        HTML = "application/html",
+        ILP_FP = "application/ilpfp",
+        IAP = "application/iap-assessment",
+        M4A = "audio/m4a",
+        MP3 = "audio/mpeg",
+        MP4 = "video/mp4",
+        M3U8 = "application/x-mpegURL",
+        INTERACTION = "video/interactive",
+        PDF = "application/pdf",
+        QUIZ = "application/quiz",
+        DRAG_DROP = "application/drag-drop",
+        HTML_PICKER = "application/htmlpicker",
+        WEB_MODULE = "application/web-module",
+        WEB_MODULE_EXERCISE = "application/web-module-exercise",
+        YOUTUBE = "video/x-youtube",
+        HANDS_ON = "application/integrated-hands-on",
+        RDBMS_HANDS_ON = "application/rdbms",
+        CLASS_DIAGRAM = "application/class-diagram",
+        CHANNEL = "application/channel",
+        COLLECTION_RESOURCE = "resource/collection",
+        CERTIFICATION = "application/certification",
+        PLAYLIST = "application/playlist",
+        QUESTION_SET = "application/vnd.sunbird.questionset",
+        QUESTION = "application/vnd.sunbird.question",
+        UNKNOWN = "application/unknown",
+        OFFLINE_SESSION = "application/offline"
+    }
+    export enum EDisplayContentTypes {
+        ASSESSMENT = "ASSESSMENT",
+        AUDIO = "AUDIO",
+        CERTIFICATION = "CERTIFICATION",
+        CHANNEL = "Channel",
+        CLASS_DIAGRAM = "CLASS_DIAGRAM",
+        COURSE = "COURSE",
+        DEFAULT = "DEFAULT",
+        DRAG_DROP = "DRAG_DROP",
+        EXTERNAL_CERTIFICATION = "EXTERNAL_CERTIFICATION",
+        EXTERNAL_COURSE = "EXTERNAL_COURSE",
+        GOALS = "GOALS",
+        HANDS_ON = "HANDS_ON",
+        IAP = "IAP",
+        INSTRUCTOR_LED = "INSTRUCTOR_LED",
+        INTERACTIVE_VIDEO = "INTERACTIVE_VIDEO",
+        KNOWLEDGE_ARTIFACT = "KNOWLEDGE_ARTIFACT",
+        MODULE = "MODULE",
+        PDF = "PDF",
+        PLAYLIST = "PLAYLIST",
+        PROGRAM = "PROGRAM",
+        QUIZ = "QUIZ",
+        RESOURCE = "RESOURCE",
+        RDBMS_HANDS_ON = "RDBMS_HANDS_ON",
+        VIDEO = "VIDEO",
+        WEB_MODULE = "WEB_MODULE",
+        WEB_PAGE = "WEB_PAGE",
+        YOUTUBE = "YOUTUBE",
+        KNOWLEDGE_BOARD = "Knowledge Board",
+        LEARNING_JOURNEY = "Learning Journeys"
+    }
+    export enum EFilterCategory {
+        ALL = "ALL",
+        LEARN = "LEARN",
+        PRACTICE = "PRACTICE",
+        ASSESS = "ASSESS"
+    }
+    export enum ETagType {
+        NEWLY_ADDED = "NEWLY ADDED"
+    }
+    export enum ECourseCategory {
+        INVITE_ONLY_PROGRAM = "Invite-Only Program",
+        MODERATED_PROGRAM = "Moderated Program",
+        BLENDED_PROGRAM = "Blended Program",
+        CURATED_PROGRAM = "Curated Program",
+        COURSE = "Course",
+        MODERATED_COURSE = "Moderated Course",
+        STANDALONE_ASSESSMENT = "Standalone Assessment",
+        MODERATED_ASSESSEMENT = "Moderated Assessment",
+        CASE_STUDY = "Case Study"
+    }
+    export {};
+}

package/lib/services/widget-content.service.d.ts

@@ -0,0 +1,54 @@
+import { HttpClient } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { ConfigurationsService } from './configurations.service';
+import { NsContentStripMultiple } from './content-strip-multiple.model';
+import { NsContent } from './widget-content.model';
+import { NSSearch } from './widget-search.model';
+import * as i0 from "@angular/core";
+export declare class WidgetContentService {
+    private http;
+    private configSvc;
+    constructor(http: HttpClient, configSvc: ConfigurationsService);
+    fetchMarkAsCompleteMeta(identifier: string): Promise<any>;
+    fetchContent(contentId: string, hierarchyType?: 'all' | 'minimal' | 'detail', additionalFields?: string[]): Observable<NsContent.IContent>;
+    fetchAuthoringContent(contentId: string): Observable<NsContent.IContent>;
+    fetchMultipleContent(ids: string[]): Observable<NsContent.IContent[]>;
+    fetchCollectionHierarchy(type: string, id: string, pageNumber?: number, pageSize?: number): Observable<NsContent.ICollectionHierarchyResponse>;
+    fetchContentLikes(contentIds: {
+        content_id: string[];
+    }): Promise<{
+        [identifier: string]: number;
+    }>;
+    fetchContentRatings(contentIds: {
+        contentIds: string[];
+    }): Promise<unknown>;
+    fetchContentHistory(contentId: string): Observable<NsContent.IContinueLearningData>;
+    continueLearning(id: string, collectionId?: string, collectionType?: string): Promise<any>;
+    saveContinueLearning(content: NsContent.IViewerContinueLearningRequest): Observable<any>;
+    setS3Cookie(_contentId: string): Observable<any>;
+    setS3ImageCookie(): Observable<any>;
+    fetchManifest(url: string): Observable<any>;
+    fetchWebModuleContent(url: string): Observable<any>;
+    search(req: NSSearch.ISearchRequest): Observable<NSSearch.ISearchApiResult>;
+    searchRegionRecommendation(req: NSSearch.ISearchOrgRegionRecommendationRequest): Observable<NsContentStripMultiple.IContentStripResponseApi>;
+    searchV6(req: NSSearch.ISearchV6Request): Observable<NSSearch.ISearchV6ApiResult>;
+    fetchContentRating(contentId: string): Observable<{
+        rating: number;
+    }>;
+    deleteContentRating(contentId: string): Observable<any>;
+    addContentRating(contentId: string, data: {
+        rating: number;
+    }): Observable<any>;
+    getFirstChildInHierarchy(content: NsContent.IContent): NsContent.IContent;
+    getRegistrationStatus(source: string): Promise<{
+        hasAccess: boolean;
+        registrationUrl?: string;
+    }>;
+    fetchConfig(url: string): Observable<any>;
+    fetchExtUserContentEnroll(contentId: string): Observable<any>;
+    extContentEnroll(requestBody: any): Observable<any>;
+    downloadCert(certId: any): Observable<any>;
+    downloadCertV2(payload: any): Observable<any>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WidgetContentService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<WidgetContentService>;
+}

package/lib/services/widget-resolver.model.d.ts

@@ -0,0 +1,48 @@
+import { Type } from '@angular/core';
+import { SafeStyle } from '@angular/platform-browser';
+type TUrl = undefined | 'none' | 'back' | string;
+export declare namespace NsWidgetResolver {
+    type UnitPermissionPrimitive = undefined | null | string;
+    interface IUnitPermissionObject {
+        all: UnitPermissionPrimitive | string[];
+        none: UnitPermissionPrimitive | string[];
+        some: UnitPermissionPrimitive | string[];
+    }
+    type UnitPermission = UnitPermissionPrimitive | string[] | IUnitPermissionObject | Pick<IUnitPermissionObject, 'all'> | Pick<IUnitPermissionObject, 'none'> | Pick<IUnitPermissionObject, 'some'> | Exclude<IUnitPermissionObject, 'all'> | Exclude<IUnitPermissionObject, 'none'> | Exclude<IUnitPermissionObject, 'some'>;
+    interface IPermissions {
+        enabled: boolean;
+        available: boolean;
+        roles?: UnitPermission;
+        features?: UnitPermission;
+        groups?: UnitPermission;
+    }
+    interface IBaseConfig {
+        widgetType: string;
+        widgetSubType: string;
+    }
+    interface IRegistrationConfig extends IBaseConfig {
+        component: Type<IWidgetData<any>>;
+    }
+    interface IRegistrationsPermissionConfig extends IBaseConfig {
+        widgetPermission?: IPermissions;
+    }
+    interface IRenderConfigWithTypedData<T> extends IRegistrationsPermissionConfig {
+        widgetData: T;
+        widgetInstanceId?: string;
+        widgetHostClass?: string;
+        widgetHostStyle?: {
+            [key: string]: string;
+        };
+    }
+    type IRenderConfigWithAnyData = IRenderConfigWithTypedData<any>;
+    interface IWidgetData<T> extends Omit<IRenderConfigWithTypedData<T>, 'widgetPermission' | 'widgetHostStyle'> {
+        widgetSafeStyle?: SafeStyle;
+        updateBaseComponent: (widgetType: string, widgetSubType: string, widgetInstanceId?: string, widgetHostClass?: string, widgetSafeStyle?: SafeStyle) => void;
+    }
+    interface ITitle {
+        title: string;
+        url: TUrl;
+        icon?: string;
+    }
+}
+export {};

package/lib/services/widget-search.model.d.ts

@@ -0,0 +1,114 @@
+import { NsContent } from './widget-content.model';
+export declare namespace NSSearch {
+    interface IFeatureSearchConfig {
+        tabs: IConfigContentStrip[];
+    }
+    interface IFilterSearchRequest {
+        contentType?: NsContent.EContentTypes[];
+        creatorContacts?: string[];
+        labels?: string[];
+        resourceCategory?: string[];
+        catalogPaths?: string[];
+    }
+    interface ISearchRequest {
+        filters?: IFilterSearchRequest;
+        query?: string;
+        isStandAlone?: boolean;
+        instanceCatalog?: boolean;
+        locale?: string[];
+        pageNo?: number;
+        pageSize?: number;
+        uuid?: string;
+        rootOrg?: string;
+        sort?: {
+            [key: string]: string;
+        }[];
+    }
+    interface ISearchOrgRegionRecommendationRequest extends ISearchRequest {
+        defaultLabel?: string;
+        preLabelValue?: string;
+    }
+    interface ISearchV6Request {
+        visibleFilters?: ISearchV6VisibleFilters;
+        excludeSourceFields?: string[];
+        includeSourceFields?: string[];
+        sort?: ISearchSort[];
+        query: string;
+        sourceFields?: string[];
+        locale?: string[];
+        pageNo?: number;
+        pageSize?: number;
+        filters?: ISearchV6Filters[];
+        isStandAlone?: boolean;
+        didYouMean?: boolean;
+    }
+    interface ISearchSort {
+        [key: string]: 'asc' | 'desc';
+    }
+    interface ISearchV6VisibleFilters {
+        [key: string]: {
+            displayName: string;
+            order?: {
+                [key: string]: 'asc' | 'desc';
+            }[];
+        };
+    }
+    interface ISearchV6Filters {
+        andFilters?: {
+            [key: string]: string[];
+        }[];
+        notFilters?: {
+            [key: string]: string[];
+        }[];
+    }
+    interface ISearchRedirection {
+        f?: {
+            [index: string]: string[];
+        };
+        q?: string;
+        tab?: string;
+    }
+    interface IConfigContentStrip {
+        titleKey?: string;
+        title?: string;
+        reqRoles?: string[];
+        reqFeatures?: string[];
+        searchRedirection?: ISearchRedirection;
+        searchQuery?: ISearchRequest;
+        contentIds?: string[];
+    }
+    interface ISearchApiResult {
+        totalHits: number;
+        result: NsContent.IContent[];
+        filters: IFilterUnitResponse[];
+        notToBeShownFilters?: IFilterUnitResponse[];
+        filtersUsed: string[];
+    }
+    interface ISearchV6ApiResult {
+        totalHits: number;
+        result: NsContent.IContent[];
+        filtersUsed: string[];
+        notVisibleFilters: string[];
+        filters: IFilterUnitResponse[];
+        queryUsed?: string;
+        doYouMean?: string;
+    }
+    interface IFilterUnitResponse {
+        id?: string;
+        type: string;
+        displayName: string;
+        content: IFilterUnitContent[];
+    }
+    interface IFilterUnitContent {
+        type?: string;
+        id?: string;
+        displayName: string;
+        count: number;
+        children?: IFilterUnitContent[];
+    }
+    interface ITypeUnitResponse {
+        displayName: string;
+        type: string;
+        count: string;
+    }
+}

package/lib/services-new/data-transfer.service.d.ts

@@ -0,0 +1,10 @@
+import * as i0 from "@angular/core";
+export declare class DataTransferService {
+    private enrollData;
+    setEnrollData(data: any): void;
+    getEnrollData(): any;
+    clearEnrollData(): void;
+    constructor();
+    static ɵfac: i0.ɵɵFactoryDeclaration<DataTransferService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DataTransferService>;
+}

package/lib/services-new/widget-enroll.service.d.ts

@@ -0,0 +1,17 @@
+import { HttpClient } from '@angular/common/http';
+import { ConfigurationsService } from '../services/configurations.service';
+import { Observable } from 'rxjs';
+import { NsContent } from '../services/widget-content.model';
+import * as i0 from "@angular/core";
+export declare class WidgetEnrollService {
+    private http;
+    private configSvc;
+    constructor(http: HttpClient, configSvc: ConfigurationsService);
+    fetchEnrollContentData(payload: any): Observable<NsContent.IContent[]>;
+    fetchInternalEnrollmentData(userId: string, payload: any): Observable<Object>;
+    fetchExternalEnrollmentData(payload: any): Observable<any>;
+    fetchEventsEnrollmentData(userId: string, payload: any): Observable<Object>;
+    fetchEnrollStats(userId: any): Observable<NsContent.IContent[]>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WidgetEnrollService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<WidgetEnrollService>;
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@sunbird-cb/utils-v2",
+  "version": "0.0.0-watch+1750611703003",
+  "main": "./src/public-api.ts",
+  "dependencies": {
+    "tslib": "^2.0.0"
+  },
+  "peerDependencies": {
+    "@angular/animations": "^16.2.12",
+    "@angular/cdk": "^16.2.14",
+    "@angular/common": "^16.2.12",
+    "@angular/compiler": "^16.2.12",
+    "@angular/core": "^16.2.12",
+    "@angular/forms": "^16.2.12",
+    "@angular/material": "^16.2.14",
+    "@angular/platform-browser": "^16.2.12",
+    "@angular/platform-browser-dynamic": "^16.2.12",
+    "@angular/router": "^16.2.12",
+    "ngx-image-cropper": "^6.3.4",
+    "@types/lodash": "^4.14.168",
+    "moment": "^2.29.1",
+    "rxjs": "~6.5.2"
+  },
+  "module": "fesm2022/sunbird-cb-utils-v2.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "esm2022": "./esm2022/sunbird-cb-utils-v2.mjs",
+      "esm": "./esm2022/sunbird-cb-utils-v2.mjs",
+      "default": "./fesm2022/sunbird-cb-utils-v2.mjs"
+    }
+  },
+  "sideEffects": false
+}