@sunbird-cb/consumption 0.0.1

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

@@ -0,0 +1,497 @@
+export declare namespace NsContent {
+    interface IContinueLearningData extends IContent {
+        continueData: any;
+    }
+    interface IContinueLearningDataReq {
+        request: {
+            userId: string | undefined;
+            courseId: string;
+            contentIds: string[];
+            batchId: string | undefined | null;
+            fields?: string[];
+        };
+    }
+    interface IContent {
+        platform?: any;
+        addedOn: string;
+        appIcon: string;
+        artifactUrl: string;
+        averageRating?: any;
+        batches?: any;
+        batch?: any;
+        body?: string;
+        certificationList?: IRelatedContentMeta[];
+        certificationStatus?: TCertificationStatus;
+        certificationSubmissionDate?: string;
+        certificationUrl: string;
+        childNodes?: string[];
+        children: IContent[];
+        childrenClassifiers?: string[];
+        clients?: IClient[];
+        collections?: IContent[];
+        completionPercentage?: number | null;
+        completionStatus?: number;
+        difficultyLevel: string;
+        contentId: string;
+        contentType: EContentTypes;
+        contentUrlAtSource: string;
+        creatorContacts: ICreator[];
+        creatorDetails: ICreator[];
+        creatorLogo: string;
+        creatorPosterImage: string;
+        creatorThumbnail: string;
+        curatedTags: string[];
+        description: string;
+        displayContentType: EDisplayContentTypes;
+        downloadUrl?: string;
+        duration: number;
+        enrolledDate?: string;
+        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[];
+        lastContentAccessTime?: string;
+        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;
+        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;
+        };
+        primaryCategory: EPrimaryCategory;
+        proctorUrl?: string;
+        progress?: IMarkAsCompleteProgress;
+        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;
+        lastReadContentId?: string;
+        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[];
+    }
+    interface IContentResponse {
+        id: string;
+        params: any;
+        responseCode: string;
+        result: {
+            content: IContent;
+        };
+        ts: string;
+        ver: string;
+    }
+    interface IBatch {
+        batchId: string;
+        createdBy: string;
+        endDate: string | null;
+        enrollmentType: string;
+        identifier: string;
+        name: string;
+        startDate: string;
+        status: number;
+        cert_templates?: null;
+        collectionId: string;
+        courseId: string;
+        createdDate: string;
+        createdFor: string[];
+        description?: null;
+        enrollmentEndDate: string | null;
+        id: string;
+        mentors?: string[] | null;
+        tandc?: null;
+        updatedDate?: string | null;
+    }
+    interface IBatchListResponse {
+        content?: IBatch[];
+        count?: number;
+        enrolled?: boolean;
+        workFlow?: {
+            wfInitiated?: boolean;
+            batch?: any;
+            wfItem?: any;
+        };
+    }
+    interface ICourse {
+        active: true;
+        addedBy: string;
+        batch: IBatch;
+        batchId: string;
+        certificates: [];
+        collectionId: string;
+        completedOn: string | null;
+        completionPercentage: number | null;
+        completionStatus?: number;
+        content: IContent;
+        contentId: string;
+        contentStatus: any;
+        courseId: string;
+        courseLogoUrl: string;
+        courseName: string;
+        dateTime: number;
+        description: string;
+        enrolledDate: string;
+        issuedCertificates: [];
+        lastContentAccessTime?: string;
+        lastReadContentId?: string;
+        lastReadContentStatus: string | null;
+        leafNodesCount: number;
+        progress: number;
+        status: number;
+        userId: string;
+    }
+    interface IContentMinimal {
+        appIcon: string;
+        artifactUrl: string;
+        difficultyLevel: string;
+        contentType: EContentTypes;
+        description: string;
+        displayContentType?: EDisplayContentTypes;
+        duration: number;
+        identifier: string;
+        hasAccess?: boolean;
+        isInIntranet?: boolean;
+        learningMode?: TLearningMode;
+        mimeType: EMimeTypes;
+        name: string;
+        creatorDetails: ICreator[];
+        creatorContacts: ICreator[];
+        posterImage: string;
+        primaryCategory: EPrimaryCategory;
+        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;
+    }
+    /**
+      * @deprecated Enum EContentTypes should not be used in future
+      */
+    enum EContentTypes {
+        PROGRAMV2 = "Program",
+        PROGRAM = "Learning Path",
+        CHANNEL = "Channel",
+        COURSE = "Course",
+        KNOWLEDGE_ARTIFACT = "Knowledge Artifact",
+        KNOWLEDGE_BOARD = "Knowledge Board",
+        LEARNING_JOURNEY = "Learning Journeys",
+        MODULE = "CourseUnit",
+        RESOURCE = "Resource"
+    }
+    enum EPrimaryCategory {
+        PROGRAM = "Program",
+        COURSE = "Course",
+        MODULE = "Course Unit",
+        RESOURCE = "Learning Resource",
+        GOALS = "GOALS",
+        PLAYLIST = "PLAYLIST",
+        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",
+        STANDALONE_ASSESSMENT = "Standalone Assessment",
+        BLENDED_PROGRAM = "Blended Program",
+        OFFLINE_SESSION = "Offline Session",
+        CURATED_PROGRAM = "Curated Program",
+        /**
+         * @deprecated The type should not be used
+         */
+        KNOWLEDGE_ARTIFACT = "Knowledge Artifact",
+        /**
+        * @deprecated The type should not be used
+        */
+        KNOWLEDGE_BOARD = "Knowledge Board",
+        /**
+        * @deprecated The type should not be used
+        */
+        LEARNING_JOURNEY = "Learning Journeys",
+        /**
+        * @deprecated The type should not be used
+        */
+        CHANNEL = "Channel"
+    }
+    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"
+    }
+    enum WFBlendedProgramStatus {
+        INITIATE = "INITIATE",
+        SEND_FOR_MDO_APPROVAL = "SEND_FOR_MDO_APPROVAL",
+        SEND_FOR_PC_APPROVAL = "SEND_FOR_PC_APPROVAL",
+        APPROVED = "APPROVED",
+        REJECTED = "REJECTED",
+        WITHDRAWN = "WITHDRAWN",
+        REMOVED = "REMOVED",
+        WITHDRAW = "WITHDRAW"
+    }
+    enum WFBlendedProgramApprovalTypes {
+        ONE_STEP_PC = "oneStepPCApproval",
+        ONE_STEP_MDO = "oneStepMDOApproval",
+        TWO_STEP_MDO_PC = "twoStepMDOAndPCApproval",
+        TWO_STEP_PC_MDO = "twoStepPCAndMDOApproval"
+    }
+    const WFSTATUS_MSG_MAPPING: any;
+    enum EResourcePrimaryCategories {
+        LEARNING_RESOURCE = "Learning Resource",
+        PRACTICE_RESOURCE = "Practice Question Set",
+        FINAL_ASSESSMENT = "Course Assessment",
+        COMP_ASSESSMENT = "Competency Assessment",
+        OFFLINE_SESSION = "Offline Session"
+    }
+    enum EMiscPlayerSupportedCollectionTypes {
+        PLAYLIST = "Playlist"
+    }
+    const PLAYER_SUPPORTED_COLLECTION_TYPES: string[];
+    const KB_SUPPORTED_CONTENT_TYPES: EPrimaryCategory[];
+    const PLAYLIST_SUPPORTED_CONTENT_TYPES: EPrimaryCategory[];
+    enum EMimeTypes {
+        COLLECTION = "application/vnd.ekstep.content-collection",
+        ZIP = "application/vnd.ekstep.html-archive",
+        ZIP2 = "application/vnd.ekstep.ecml-archive",
+        HTML = "application/html",
+        HTML_TEXT = "text/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",
+        APPLICATION_JSON = "application/json",
+        PRACTICE_RESOURCE = "application/vnd.sunbird.questionset",
+        FINAL_ASSESSMENT = "application/vnd.sunbird.questionset",
+        OFFLINE_SESSION = "application/offline",
+        CERTIFICATION = "application/certification",
+        PLAYLIST = "application/playlist",
+        TEXT_WEB = "text/x-url",
+        SURVEY = "application/survey",
+        QUESTION_SET = "application/vnd.sunbird.questionset",
+        QUESTION = "application/vnd.sunbird.question",
+        UNKNOWN = "application/unknown"
+    }
+    enum EDisplayContentTypes {
+        ASSESSMENT = "ASSESSMENT",
+        STANDALONE_ASSESSMENT = "STANDALONE ASSESSMENT",
+        PRACTICE_RESOURCE = "Practice Question Set",
+        FINAL_ASSESSMENT = "Course 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",
+        SURVEY = "SURVEY",
+        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",
+        LINK = "LINK",
+        KNOWLEDGE_BOARD = "Knowledge Board",
+        LEARNING_JOURNEY = "Learning Journeys",
+        BLENDED_PROGRAM = "BLENDED PROGRAM",
+        CURATED_PROGRAM = "CURATED PROGRAM"
+    }
+    enum EFilterCategory {
+        ALL = "ALL",
+        LEARN = "LEARN",
+        PRACTICE = "PRACTICE",
+        ASSESS = "ASSESS"
+    }
+    enum ETagType {
+        NEWLY_ADDED = "NEWLY ADDED"
+    }
+    const UN_SUPPORTED_DATA_TYPES_FOR_NON_BATCH_USERS: string[];
+    const PUBLIC_SUPPORTED_CONTENT_TYPES: EMimeTypes[];
+}