@sunbird-cb/utils-v2 0.0.11 → 0.0.13

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

@@ -1,344 +1,344 @@
-export declare namespace NsContent {
-    interface IContinueLearningData extends IContent {
-        continueData: any;
-    }
-    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[];
-    }
-    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"
-    }
-    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;
-    }
-    interface ICollectionHierarchyResponse {
-        data: IContent;
-        hasMore: boolean;
-        totalContents: number;
-    }
-    interface IRelatedContentMeta {
-        identifier: string;
-        name: string;
-    }
-    type TCertificationStatus = 'ongoing' | 'passed' | 'canAttempt' | 'cannotAttempt';
-    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;
-    }
-    interface ICreator {
-        id: string;
-        name: string;
-        email: string;
-    }
-    interface IContentTopic {
-        identifier: string;
-        name: string;
-    }
-    interface IContact {
-        id: string;
-        name: string;
-        email: string;
-    }
-    interface IViewerContinueLearningRequest {
-        resourceId: string;
-        contextPathId: string;
-        data: string;
-        dateAccessed: number;
-        contextType?: string;
-    }
-    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"
-    }
-    enum EMiscPlayerSupportedCollectionTypes {
-        PLAYLIST = "Playlist"
-    }
-    const PLAYER_SUPPORTED_COLLECTION_TYPES: string[];
-    const KB_SUPPORTED_CONTENT_TYPES: EContentTypes[];
-    const PLAYLIST_SUPPORTED_CONTENT_TYPES: EContentTypes[];
-    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"
-    }
-    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"
-    }
-    enum EFilterCategory {
-        ALL = "ALL",
-        LEARN = "LEARN",
-        PRACTICE = "PRACTICE",
-        ASSESS = "ASSESS"
-    }
-    enum ETagType {
-        NEWLY_ADDED = "NEWLY ADDED"
-    }
-}
+export declare namespace NsContent {
+    interface IContinueLearningData extends IContent {
+        continueData: any;
+    }
+    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[];
+    }
+    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"
+    }
+    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;
+    }
+    interface ICollectionHierarchyResponse {
+        data: IContent;
+        hasMore: boolean;
+        totalContents: number;
+    }
+    interface IRelatedContentMeta {
+        identifier: string;
+        name: string;
+    }
+    type TCertificationStatus = 'ongoing' | 'passed' | 'canAttempt' | 'cannotAttempt';
+    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;
+    }
+    interface ICreator {
+        id: string;
+        name: string;
+        email: string;
+    }
+    interface IContentTopic {
+        identifier: string;
+        name: string;
+    }
+    interface IContact {
+        id: string;
+        name: string;
+        email: string;
+    }
+    interface IViewerContinueLearningRequest {
+        resourceId: string;
+        contextPathId: string;
+        data: string;
+        dateAccessed: number;
+        contextType?: string;
+    }
+    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"
+    }
+    enum EMiscPlayerSupportedCollectionTypes {
+        PLAYLIST = "Playlist"
+    }
+    const PLAYER_SUPPORTED_COLLECTION_TYPES: string[];
+    const KB_SUPPORTED_CONTENT_TYPES: EContentTypes[];
+    const PLAYLIST_SUPPORTED_CONTENT_TYPES: EContentTypes[];
+    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"
+    }
+    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"
+    }
+    enum EFilterCategory {
+        ALL = "ALL",
+        LEARN = "LEARN",
+        PRACTICE = "PRACTICE",
+        ASSESS = "ASSESS"
+    }
+    enum ETagType {
+        NEWLY_ADDED = "NEWLY ADDED"
+    }
+}