@aastrika_npmjs/sunbird-sdk 5.1.1

package/summarizer/def/summarizer-service.d.ts

@@ -0,0 +1,22 @@
+import { Observable } from 'rxjs';
+import { LearnerAssessmentSummary, ReportDetailPerUser } from './response';
+import { SummaryRequest } from './request';
+import { SunbirdTelemetry } from '../../telemetry';
+import { SdkServiceOnInitDelegate } from '../../sdk-service-on-init-delegate';
+import Telemetry = SunbirdTelemetry.Telemetry;
+export interface SummarizerService extends SdkServiceOnInitDelegate {
+    getSummary(request: SummaryRequest): Observable<LearnerAssessmentSummary[]>;
+    getLearnerAssessmentDetails(request: SummaryRequest): Observable<Map<string, ReportDetailPerUser>>;
+    saveLearnerAssessmentDetails(event: Telemetry): Observable<boolean>;
+    saveLearnerContentSummaryDetails(event: Telemetry): Observable<boolean>;
+    getReportsByUser(request: SummaryRequest): Observable<{
+        [key: string]: any;
+    }[]>;
+    getReportByQuestions(request: SummaryRequest): Observable<{
+        [key: string]: any;
+    }[]>;
+    getDetailsPerQuestion(request: SummaryRequest): Observable<{
+        [key: string]: any;
+    }[]>;
+    deletePreviousAssessmentDetails(uid: string, contentId: string): Observable<undefined>;
+}

package/summarizer/handler/summarizer-handler.d.ts

@@ -0,0 +1,22 @@
+import { LearnerAssessmentsEntry, LearnerSummaryEntry } from '../../profile/db/schema';
+import { ContentCache, LearnerAssessmentDetails, LearnerAssessmentSummary, LearnerContentSummaryDetails, QuestionSummary, ReportDetailPerUser, UserReportSummary } from '..';
+import { SunbirdTelemetry } from '../../telemetry';
+import Telemetry = SunbirdTelemetry.Telemetry;
+export declare class SummarizerHandler {
+    constructor();
+    static mapLearnerAssesmentDetailsToDbEntries(learnerAssessmentDetails: LearnerAssessmentDetails): LearnerAssessmentsEntry.SchemaMap;
+    static mapContentSummaryDetailsToDbEntries(learnerContentSummaryDetails: LearnerContentSummaryDetails): LearnerSummaryEntry.SchemaMap;
+    static mapDBEntriesToLearnerAssesmentSummary(assesmentsInDb: LearnerSummaryEntry.SchemaMap[], cache: Map<string, ContentCache>): LearnerAssessmentSummary[];
+    static mapDBEntriesToLearnerAssesmentDetails(assesmentDetailsInDb: LearnerAssessmentsEntry.SchemaMap[]): Map<string, ReportDetailPerUser>;
+    static mapDBEntriesToQuestionReports(accuracyMap: {
+        [p: string]: any;
+    }, questionReportsInDb: LearnerAssessmentsEntry.QuestionReportsSchema[]): LearnerAssessmentDetails[];
+    static mapDBEntriesToAccuracy(accuracyReportsInDb: LearnerAssessmentsEntry.AccuracySchema[]): {
+        [key: string]: string;
+    };
+    static mapDBEntriesToQuestionDetails(questionSummaries: QuestionSummary[]): QuestionSummary[];
+    static mapDBEntriesToUserReports(userReportsInDb: LearnerAssessmentsEntry.UserReportSchema[]): UserReportSummary[];
+    static mapTelemetryToContentSummaryDetails(telemetry: Telemetry): LearnerContentSummaryDetails;
+    static mapTelemetryToLearnerAssesmentDetails(telemetry: Telemetry): LearnerAssessmentDetails;
+    private static getHierarchyData;
+}

package/summarizer/handler/summarizer-queries.d.ts

@@ -0,0 +1,12 @@
+export declare class SummarizerQueries {
+    static getChildProgressQuery(uids: string[]): string;
+    static getDetailReportsQuery(uids: string[], contentId: string): string;
+    static getReportsByUserQuery(uids: string[], contentId: string): string;
+    static getQuetsionDetailsQuery(uids: string[], contentId: string, qid: string): string;
+    static getReportAccuracyQuery(uids: string[], contentId: string): string;
+    static getQuestionReportsQuery(uids: string[], contentId: string): string;
+    static getFilterForLearnerAssessmentDetails(qid: string, uid: string, contentId: string, hierarchyData: string): string;
+    static getLearnerAssessmentsQuery(filter: string): string;
+    static getUpdateSelection(): string;
+    static getLearnerSummaryReadSelection(hData: string): string;
+}

package/summarizer/handler/summary-telemetry-event-handler.d.ts

@@ -0,0 +1,40 @@
+import { ApiRequestHandler } from '../../api';
+import { SunbirdTelemetry } from '../../telemetry';
+import { SummarizerService } from '..';
+import { CourseService } from '../../course';
+import { SharedPreferences } from '../../util/shared-preferences';
+import { EventsBusService } from '../../events-bus';
+import { ContentService } from '../../content';
+import { ProfileService } from '../../profile';
+import { Observable } from 'rxjs';
+import Telemetry = SunbirdTelemetry.Telemetry;
+export declare class SummaryTelemetryEventHandler implements ApiRequestHandler<Telemetry, undefined> {
+    private courseService;
+    private sharedPreference;
+    private summarizerService;
+    private eventBusService;
+    private contentService;
+    private profileService;
+    private static readonly CONTENT_PLAYER_PID;
+    private currentUID?;
+    private currentContentID?;
+    private courseContext;
+    private trackableSessionProxyContentProvider;
+    constructor(courseService: CourseService, sharedPreference: SharedPreferences, summarizerService: SummarizerService, eventBusService: EventsBusService, contentService: ContentService, profileService: ProfileService);
+    private static checkPData;
+    private static isContentTrackable;
+    private static isCourseAssessmentContent;
+    updateContentState(event: Telemetry): Observable<undefined>;
+    handle(event: SunbirdTelemetry.Telemetry): Observable<undefined>;
+    private setCourseContextEmpty;
+    private validEndEvent;
+    private updateLastReadContentId;
+    private markContentAsPlayed;
+    private getCourseContext;
+    private checkStatusOfContent;
+    private getStatus;
+    private processOEStart;
+    private processOEAssess;
+    private processOEEnd;
+    private generateAuditTelemetry;
+}

package/summarizer/impl/summarizer-service-impl.d.ts

@@ -0,0 +1,40 @@
+import { LearnerAssessmentSummary, ReportDetailPerUser, SummarizerService, SummaryRequest } from '..';
+import { DbService } from '../../db';
+import { SunbirdTelemetry } from '../../telemetry';
+import { EventsBusService } from '../../events-bus';
+import { ContentService } from '../../content';
+import { TelemetryEvent } from '../../telemetry/def/telemetry-event';
+import { CourseService } from '../../course';
+import { SharedPreferences } from '../../util/shared-preferences';
+import { ProfileService } from '../../profile';
+import { EventObserver } from '../../events-bus/def/event-observer';
+import { Observable } from 'rxjs';
+import Telemetry = SunbirdTelemetry.Telemetry;
+export declare class SummarizerServiceImpl implements SummarizerService, EventObserver<TelemetryEvent> {
+    private dbService;
+    private contenService;
+    private eventsBusService;
+    private courseService;
+    private sharedPreference;
+    private profileService;
+    private contentMap;
+    private summarizerTelemetryHandler;
+    constructor(dbService: DbService, contenService: ContentService, eventsBusService: EventsBusService, courseService: CourseService, sharedPreference: SharedPreferences, profileService: ProfileService);
+    onInit(): Observable<undefined>;
+    getDetailsPerQuestion(request: SummaryRequest): Observable<{
+        [p: string]: any;
+    }[]>;
+    getLearnerAssessmentDetails(request: SummaryRequest): Observable<Map<string, ReportDetailPerUser>>;
+    getReportByQuestions(request: SummaryRequest): Observable<{
+        [p: string]: any;
+    }[]>;
+    getReportsByUser(request: SummaryRequest): Observable<{
+        [p: string]: any;
+    }[]>;
+    getSummary(request: SummaryRequest): Observable<LearnerAssessmentSummary[]>;
+    private getContentCache;
+    saveLearnerAssessmentDetails(event: Telemetry): Observable<boolean>;
+    saveLearnerContentSummaryDetails(event: Telemetry): Observable<boolean>;
+    deletePreviousAssessmentDetails(uid: string, contentId: string): Observable<undefined>;
+    onEvent(event: TelemetryEvent): Observable<undefined>;
+}

package/summarizer/index.d.ts

@@ -0,0 +1,7 @@
+export * from './impl/summarizer-service-impl';
+export * from './def/request';
+export * from './def/response';
+export * from './def/summarizer-service';
+export * from './handler/summarizer-handler';
+export * from './handler/summarizer-queries';
+export * from './handler/summary-telemetry-event-handler';

package/sunbird-error.d.ts

@@ -0,0 +1,5 @@
+export declare abstract class SunbirdError extends Error {
+    private readonly _code;
+    protected constructor(message: string, code: string);
+    readonly code: string;
+}

package/system-settings/config/system-settings-config.d.ts

@@ -0,0 +1,4 @@
+export interface SystemSettingsConfig {
+    systemSettingsApiPath: string;
+    systemSettingsDirPath: string;
+}

package/system-settings/def/request-types.d.ts

@@ -0,0 +1,3 @@
+export interface GetSystemSettingsRequest {
+    id: string;
+}

package/system-settings/def/system-settings-org-ids.d.ts

@@ -0,0 +1,5 @@
+export declare enum SystemSettingsOrgIds {
+    CUSTODIAN_ORG_ID = "custodianOrgId",
+    COURSE_FRAMEWORK_ID = "courseFrameworkId",
+    ERROR_LOG_SYNC_SETTINGS = "errorLogSyncSettings"
+}

package/system-settings/def/system-settings-service.d.ts

@@ -0,0 +1,5 @@
+import { Observable } from 'rxjs';
+import { GetSystemSettingsRequest, SystemSettings } from '..';
+export interface SystemSettingsService {
+    getSystemSettings(request: GetSystemSettingsRequest): Observable<SystemSettings>;
+}

package/system-settings/def/system-settings.d.ts

@@ -0,0 +1,5 @@
+export interface SystemSettings {
+    id: string;
+    field: string;
+    value: string;
+}

package/system-settings/handlers/get-system-settings-handler.d.ts

@@ -0,0 +1,18 @@
+import { CachedItemStore } from '../../key-value-store';
+import { FileService } from '../../util/file/def/file-service';
+import { GetSystemSettingsRequest, SystemSettings, SystemSettingsConfig } from '..';
+import { ApiRequestHandler, ApiService } from '../../api';
+import { Observable } from 'rxjs';
+export declare class GetSystemSettingsHandler implements ApiRequestHandler<GetSystemSettingsRequest, SystemSettings> {
+    private apiService;
+    private systemSettingsConfig;
+    private fileservice;
+    private cachedItemStore;
+    private readonly SYSTEM_SETTINGS_FILE_KEY_PREFIX;
+    private readonly SYSTEM_SETTINGS_LOCAL_KEY;
+    private readonly GET_SYSTEM_SETTINGS_ENDPOINT;
+    constructor(apiService: ApiService, systemSettingsConfig: SystemSettingsConfig, fileservice: FileService, cachedItemStore: CachedItemStore);
+    handle(request: GetSystemSettingsRequest): Observable<SystemSettings>;
+    private fetchFromServer;
+    private fetchFromFile;
+}

package/system-settings/impl/system-settings-service-impl.d.ts

@@ -0,0 +1,15 @@
+import { CachedItemStore } from '../../key-value-store';
+import { GetSystemSettingsRequest, SystemSettings, SystemSettingsService } from '..';
+import { FileService } from '../../util/file/def/file-service';
+import { Observable } from 'rxjs';
+import { ApiService } from '../../api';
+import { SdkConfig } from '../../sdk-config';
+export declare class SystemSettingsServiceImpl implements SystemSettingsService {
+    private sdkConfig;
+    private apiService;
+    private fileService;
+    private cachedChannelItemStore;
+    private systemSettingsConfig;
+    constructor(sdkConfig: SdkConfig, apiService: ApiService, fileService: FileService, cachedChannelItemStore: CachedItemStore);
+    getSystemSettings(request: GetSystemSettingsRequest): Observable<SystemSettings>;
+}

package/system-settings/index.d.ts

@@ -0,0 +1,5 @@
+export * from './def/system-settings-service';
+export * from './def/system-settings';
+export * from './def/request-types';
+export * from './config/system-settings-config';
+export * from './impl/system-settings-service-impl';

package/telemetry/config/telemetry-config.d.ts

@@ -0,0 +1,7 @@
+import { OpenRapConfigurable } from '../../open-rap-configurable';
+export interface TelemetryConfig extends OpenRapConfigurable {
+    apiPath: string;
+    telemetrySyncBandwidth: number;
+    telemetrySyncThreshold: number;
+    telemetryLogMinAllowedOffset: number;
+}

package/telemetry/db/schema.d.ts

@@ -0,0 +1,66 @@
+export declare namespace TelemetryEntry {
+    const _ID = "_id";
+    const TABLE_NAME = "telemetry";
+    const COLUMN_NAME_EVENT_TYPE = "event_type";
+    const COLUMN_NAME_EVENT = "event";
+    const COLUMN_NAME_TIMESTAMP = "timestamp";
+    const COLUMN_NAME_PRIORITY = "priority";
+    interface SchemaMap {
+        [_ID]: string;
+        [COLUMN_NAME_EVENT_TYPE]: string;
+        [COLUMN_NAME_EVENT]: string;
+        [COLUMN_NAME_TIMESTAMP]: number;
+        [COLUMN_NAME_PRIORITY]: number;
+    }
+    const getCreateEntry: (() => string);
+    const getDeleteEntry: (() => string);
+}
+export declare namespace TelemetryProcessedEntry {
+    const _ID = "_id";
+    const TABLE_NAME = "processed_telemetry";
+    const COLUMN_NAME_MSG_ID = "msg_id";
+    const COLUMN_NAME_DATA = "data";
+    const COLUMN_NAME_NUMBER_OF_EVENTS = "event_count";
+    const COLUMN_NAME_PRIORITY = "priority";
+    interface SchemaMap {
+        [_ID]: string;
+        [COLUMN_NAME_MSG_ID]: string;
+        [COLUMN_NAME_DATA]: string;
+        [COLUMN_NAME_NUMBER_OF_EVENTS]: number;
+        [COLUMN_NAME_PRIORITY]: number;
+    }
+    const getCreateEntry: (() => string);
+    const getDeleteEntry: (() => string);
+}
+export declare namespace EventPriorityEntry {
+    const _ID = "_id";
+    const TABLE_NAME = "event_priority";
+    const COLUMN_NAME_EVENT = "event";
+    const COLUMN_NAME_PRIORITY = "priority";
+    const getCreateEntry: (() => string);
+    const getDeleteEntry: (() => string);
+}
+export declare namespace TelemetryTagEntry {
+    const _ID = "_id";
+    const TABLE_NAME = "telemetry_tags";
+    const COLUMN_NAME_NAME = "name";
+    const COLUMN_NAME_HASH = "hash";
+    const COLUMN_NAME_DESCRIPTION = "description";
+    const COLUMN_NAME_START_DATE = "start_date";
+    const COLUMN_NAME_END_DATE = "end_date";
+    const getCreateEntry: (() => string);
+    const getDeleteEntry: (() => string);
+}
+export declare namespace MetaEntry {
+    const _ID = "_id";
+    const TABLE_NAME = "meta_data";
+    const COLUMN_NAME_MSG_ID = "key";
+    const COLUMN_NAME_DATA = "value";
+    interface SchemaMap {
+        [_ID]: string;
+        [COLUMN_NAME_MSG_ID]: string;
+        [COLUMN_NAME_DATA]: string;
+    }
+    const getCreateEntry: (() => string);
+    const getDeleteEntry: (() => string);
+}

package/telemetry/def/requests.d.ts

@@ -0,0 +1,171 @@
+import { Environment, InteractType, LogLevel, LogType, PageId, ShareItemType } from './telemetry-constants';
+import { Actor, AuditState, CorrelationData, DeviceSpecification, Rollup, Visit } from './telemetry-model';
+export interface TelemetryAuditRequest {
+    env: string;
+    actor: Actor;
+    currentState: AuditState;
+    updatedProperties?: string[];
+    type?: string;
+    objId?: string;
+    objType?: string;
+    objVer?: string;
+    correlationData?: Array<CorrelationData>;
+    rollUp?: Rollup;
+}
+export declare class TelemetryInteractRequest {
+    type: InteractType;
+    subType: string;
+    id?: string;
+    pageId?: string;
+    pos?: Array<{
+        [index: string]: string;
+    }>;
+    env: string;
+    rollup?: Rollup;
+    valueMap?: {
+        [index: string]: any;
+    };
+    correlationData?: Array<CorrelationData>;
+    objId?: string;
+    objType?: string;
+    objVer?: string;
+}
+export declare class TelemetryErrorRequest {
+    errorCode: string;
+    errorType: string;
+    stacktrace: string;
+    pageId: string;
+}
+export declare class TelemetryInterruptRequest {
+    type: string;
+    pageId: string;
+}
+export declare class TelemetryImpressionRequest {
+    type?: string;
+    subType?: string;
+    pageId?: PageId;
+    visits?: Visit[];
+    env: string;
+    objId?: string;
+    objType?: string;
+    objVer?: string;
+    correlationData?: Array<CorrelationData>;
+    rollup?: Rollup;
+}
+export declare class TelemetryStartRequest {
+    type?: string;
+    deviceSpecification?: DeviceSpecification;
+    loc?: string;
+    mode?: string;
+    duration?: number;
+    pageId?: string;
+    env: Environment;
+    objId?: string;
+    objType?: string;
+    objVer?: string;
+    rollup?: Rollup;
+    correlationData?: Array<CorrelationData>;
+}
+export declare class TelemetrySummaryRequest {
+    type: string;
+    starttime: number;
+    endtime: number;
+    timespent: number;
+    pageviews: number;
+    interactions: number;
+    env: Environment;
+    mode?: string;
+    envsummary?: {
+        env: string;
+        timespent: number;
+        visits: number;
+    }[];
+    eventsummary?: {
+        id: string;
+        count: number;
+    }[];
+    pagesummary?: {
+        id: string;
+        type: string;
+        env: string;
+        timespent: number;
+        visits: number;
+    }[];
+    extra?: {
+        id: string;
+        value: string;
+    }[];
+    correlationData?: Array<CorrelationData>;
+    objId?: string;
+    objType?: string;
+    objVer?: string;
+    rollup?: Rollup;
+}
+export declare class TelemetryEndRequest {
+    env: Environment;
+    type?: string;
+    mode?: string;
+    duration?: number;
+    pageId?: string;
+    objId?: string;
+    objType?: string;
+    objVer?: string;
+    rollup?: Rollup;
+    summaryList?: Array<{
+        [index: string]: any;
+    }>;
+    correlationData?: Array<CorrelationData>;
+}
+export declare class TelemetryFeedbackRequest {
+    env: string;
+    rating?: number;
+    comments: string;
+    objId: string;
+    objType: string;
+    objVer: string;
+    commentid?: string;
+    commenttxt?: string;
+}
+export declare class TelemetryLogRequest {
+    type: LogType;
+    level: LogLevel;
+    message: string;
+    pageId: string;
+    params: Array<{
+        [index: string]: any;
+    }>;
+    env: Environment;
+    actorType: string;
+}
+export declare class TelemetryShareRequest {
+    dir: string;
+    type: string;
+    items: Array<Item>;
+    env: string;
+    correlationData?: Array<CorrelationData>;
+    objId?: string;
+    objType?: string;
+    objVer?: string;
+    rollUp?: Rollup;
+}
+export interface Item {
+    type: ShareItemType | string;
+    origin: string;
+    identifier: string;
+    pkgVersion: number;
+    transferCount: number;
+    size: string;
+}
+export interface ImportTelemetryContext {
+    sourceDBFilePath: string;
+    metadata?: {
+        [index: string]: any;
+    };
+}
+export interface TelemetryImportRequest {
+    sourceFilePath: string;
+}
+export interface TelemetrySyncRequest {
+    ignoreSyncThreshold?: boolean;
+    ignoreAutoSyncMode?: boolean;
+}

package/telemetry/def/telemetry-constants.d.ts

@@ -0,0 +1,64 @@
+export declare type Workflows = string;
+export declare type Environment = string;
+export declare enum ObjectType {
+    NOTIFICATION = "notification",
+    USER = "User",
+    GROUP = "Group",
+    CONTENT = "Content",
+    QUESTION = "Question"
+}
+export declare enum Mode {
+    PLAY = "play"
+}
+export declare type PageId = string;
+export declare enum LogType {
+    NOTIFICATION = "notification"
+}
+export declare enum LogLevel {
+    TRACE = "TRACE",
+    DEBUG = "DEBUG",
+    INFO = "INFO",
+    WARN = "WARN",
+    ERROR = "ERROR",
+    FATAL = "FATAL"
+}
+export declare enum ShareDirection {
+    IN = "In",
+    OUT = "Out"
+}
+export declare enum ShareType {
+    FILE = "File",
+    MESSAGE = "Message",
+    LINK = "Link"
+}
+export declare enum ShareItemType {
+    CONTENT = "CONTENT",
+    EXPLODEDCONTENT = "EXPLODEDCONTENT",
+    TELEMETRY = "TELEMETRY",
+    PROFILE = "PROFILE"
+}
+export declare class LogMessage {
+    RECEIVED: string;
+    DISPLAYED: string;
+}
+export declare enum InteractType {
+    TOUCH = "TOUCH",
+    OTHER = "OTHER"
+}
+export declare enum InteractSubType {
+    NETWORK_SPEED = "network-speed",
+    SUBTYPE_SPINE = "spine",
+    ONLINE = "online",
+    FULL = "full",
+    CONTENT_VARIANT = "content-variant-download",
+    DEVICE_TIME_OFFSET_FOUND = "device-time-offset-found",
+    CONTENT_DOWNLOAD_INITIATE = "ContentDownload-Initiate",
+    CONTENT_DOWNLOAD_SUCCESS = "ContentDownload-Success",
+    CONTENT_DOWNLOAD_CANCEL = "ContentDownload-Cancel"
+}
+export declare enum TelemetryErrorCode {
+    ERR_DOWNLOAD_FAILED = "ERR_DOWNLOAD_FAILED"
+}
+export declare enum ErrorType {
+    SYSTEM = "SYSTEM"
+}

package/telemetry/def/telemetry-decorator.d.ts

@@ -0,0 +1,13 @@
+import { Context, CorrelationData, SunbirdTelemetry } from './telemetry-model';
+import { ProfileSession } from '../../profile';
+import Telemetry = SunbirdTelemetry.Telemetry;
+export declare abstract class TelemetryDecorator {
+    abstract decorate(event: Telemetry, profileSession: ProfileSession, gid?: string, offset?: number, channelId?: string, campaignParameters?: CorrelationData[], globalCData?: CorrelationData[]): any;
+    abstract prepare(event: Telemetry, priority: number): {
+        event: any;
+        event_type: any;
+        timestamp: any;
+        priority: any;
+    };
+    abstract buildContext(sid: string, channelId: string, context: Context): Context;
+}

package/telemetry/def/telemetry-event.d.ts

@@ -0,0 +1,12 @@
+import { EventsBusEvent } from '../../events-bus';
+import { SunbirdTelemetry } from './telemetry-model';
+export interface TelemetryEvent extends EventsBusEvent {
+    type: TelemetryEventType;
+}
+export interface TelemetrySave extends TelemetryEvent {
+    type: TelemetryEventType.SAVE;
+    payload: SunbirdTelemetry.Telemetry;
+}
+export declare enum TelemetryEventType {
+    SAVE = "SAVE"
+}