@plasosdk/plaso-electron-sdk 1.3.17-beta.1 → 1.3.17

package/js/macro.js

@@ -1,103 +1,103 @@
-const ERROR_CODE = {
-    /** 非 electron 环境 */
-    NO_ELECTRON_ENVIRONMENT: -1,
-    /** 获取remote 失败 */
-    GET_REMOTE_FAIL: -2,
-    /** 获取 屏幕信息 失败 */
-    GET_DISPLAY_INFO_FAIL: -3,
-    /** 课堂窗口同时仅能存在一个 */
-    CLASS_WINODW_GREATER_THAN_ONE: -4,
-    /** 未知的异常错误 */
-    COMMOM_ERROR: -99,
-};
-
-const LESSON_TYPE = {
-    /** 课堂 */
-    LIVECLASS: 'liveClass',
-    /** 备课 */
-    PREPARE_LESSONS: 'prepareLesson',
-};
-
-/** 课堂窗口与外部窗口通讯的消息 */
-const CLASS_WINDOW_MESG_TYPE = {
-    // <<<<<<< 接收的消息 <<<<<<<
-    /** 初始化 globalAppInfo */
-    INIT_GLOBAL_APPINFO: 'init_global_appinfo',
-    /** 课堂dom渲染成功后告知外部应用窗口,传参用户信息 */
-    LIVE_WINDOW_READY: 'liveWindowReady',
-    /** 课堂结束 */
-    ON_CLASS_FINISHED: 'onClassFinished',
-    /** 保存白板文件 */
-    SAVE_BOARD: 'save_board',
-    /** 打开资料中心 */
-    OPEN_RESOURCE_CENTER: 'open_resource_center',
-    /** 通知外部调用getExtFileName */
-    GET_EXT_FILE_NAME: 'getExtFileName',
-    /** 通知外部调用getPreParseFileName */
-    GET_PRE_PARSE_FILE_NAME: 'getPreParseFileName',
-    /** 上报问题 */
-    REPORT_ISSUES: 'reportIssues',
-    /** 浏览器-获取收藏列表 */
-    FETCH_FAVORITES: 'fetchFavorites',
-    /** 浏览器-获取分类列表 */
-    FETCH_CATEGORIES: 'fetchCategories',
-    /** 浏览器-添加收藏 */
-    ADD_FAVORITE: 'addFavorite',
-    /** 浏览器-删除收藏 */
-    REMOVE_FAVORITE: 'removeFavorite',
-
-    // >>>>>>> 发送的消息 >>>>>>>
-    /** html ready */
-    HTML_READY: 'html_ready',
-    /** 更新屏蔽词 */
-    UPDATE_SENSITIVE_WORDS: 'updateSensitiveWords',
-    /** 响应保存白板文件 */
-    RESP_SAVE_BOARD: 'resp_save_board',
-    /** 插入白板文件 */
-    INSERT_BOARD: 'insert_board',
-    /** 插入文件 */
-    INSERT_OBJECT: 'insertObject',
-    RESP_GET_EXT_FILE_NAME: 'respGetExtFileName',
-    RESP_GET_PRE_PARSE_FILE_NAME: 'respGetPreParseFileName',
-    RESP_FETCH_FAVORITES: 'respFetchFavorites',
-    RESP_FETCH_CATEGORIES: 'respFetchCategories',
-    RESP_ADD_FAVORITE: 'respAddFavorite',
-    RESP_REMOVE_FAVORITE: 'respRemoveFavorite',
-};
-
-const LEVEL = {
-    error: 3,
-    warn: 2,
-    info: 1,
-    debug: 0,
-};
-
-/** 渲染进程——》主进程通讯的消息 */
-const RENDER_TO_MAIN_MESG_TYPE = {
-    /** 初始化dump生成位置 */
-    PLASO_INIT_LOG_PATH: 'plaso-init-log-path',
-};
-
-/** 插入的文件类型 */
-const FILE_TYPE = {
-    PPT: 1,
-    IMAGE: 2,
-    PDF: 3,
-    WORD: 4,
-    EXCEL: 5,
-    AUDIO: 6,
-    VIDEO: 7,
-    DOC: 14,
-    XLS: 15,
-    ISPRINGPPT: 21,
-    PREPARE_LESSONS: 22,
-};
-
-module.exports = {
-    LESSON_TYPE,
-    ERROR_CODE,
-    CLASS_WINDOW_MESG_TYPE,
-    LEVEL,
-    RENDER_TO_MAIN_MESG_TYPE,
-    FILE_TYPE,
-};
+const ERROR_CODE = {
+    /** 非 electron 环境 */
+    NO_ELECTRON_ENVIRONMENT: -1,
+    /** 获取remote 失败 */
+    GET_REMOTE_FAIL: -2,
+    /** 获取 屏幕信息 失败 */
+    GET_DISPLAY_INFO_FAIL: -3,
+    /** 课堂窗口同时仅能存在一个 */
+    CLASS_WINODW_GREATER_THAN_ONE: -4,
+    /** 未知的异常错误 */
+    COMMOM_ERROR: -99,
+};
+
+const LESSON_TYPE = {
+    /** 课堂 */
+    LIVECLASS: 'liveClass',
+    /** 备课 */
+    PREPARE_LESSONS: 'prepareLesson',
+};
+
+/** 课堂窗口与外部窗口通讯的消息 */
+const CLASS_WINDOW_MESG_TYPE = {
+    // <<<<<<< 接收的消息 <<<<<<<
+    /** 初始化 globalAppInfo */
+    INIT_GLOBAL_APPINFO: 'init_global_appinfo',
+    /** 课堂dom渲染成功后告知外部应用窗口,传参用户信息 */
+    LIVE_WINDOW_READY: 'liveWindowReady',
+    /** 课堂结束 */
+    ON_CLASS_FINISHED: 'onClassFinished',
+    /** 保存白板文件 */
+    SAVE_BOARD: 'save_board',
+    /** 打开资料中心 */
+    OPEN_RESOURCE_CENTER: 'open_resource_center',
+    /** 通知外部调用getExtFileName */
+    GET_EXT_FILE_NAME: 'getExtFileName',
+    /** 通知外部调用getPreParseFileName */
+    GET_PRE_PARSE_FILE_NAME: 'getPreParseFileName',
+    /** 上报问题 */
+    REPORT_ISSUES: 'reportIssues',
+    /** 浏览器-获取收藏列表 */
+    FETCH_FAVORITES: 'fetchFavorites',
+    /** 浏览器-获取分类列表 */
+    FETCH_CATEGORIES: 'fetchCategories',
+    /** 浏览器-添加收藏 */
+    ADD_FAVORITE: 'addFavorite',
+    /** 浏览器-删除收藏 */
+    REMOVE_FAVORITE: 'removeFavorite',
+
+    // >>>>>>> 发送的消息 >>>>>>>
+    /** html ready */
+    HTML_READY: 'html_ready',
+    /** 更新屏蔽词 */
+    UPDATE_SENSITIVE_WORDS: 'updateSensitiveWords',
+    /** 响应保存白板文件 */
+    RESP_SAVE_BOARD: 'resp_save_board',
+    /** 插入白板文件 */
+    INSERT_BOARD: 'insert_board',
+    /** 插入文件 */
+    INSERT_OBJECT: 'insertObject',
+    RESP_GET_EXT_FILE_NAME: 'respGetExtFileName',
+    RESP_GET_PRE_PARSE_FILE_NAME: 'respGetPreParseFileName',
+    RESP_FETCH_FAVORITES: 'respFetchFavorites',
+    RESP_FETCH_CATEGORIES: 'respFetchCategories',
+    RESP_ADD_FAVORITE: 'respAddFavorite',
+    RESP_REMOVE_FAVORITE: 'respRemoveFavorite',
+};
+
+const LEVEL = {
+    error: 3,
+    warn: 2,
+    info: 1,
+    debug: 0,
+};
+
+/** 渲染进程——》主进程通讯的消息 */
+const RENDER_TO_MAIN_MESG_TYPE = {
+    /** 初始化dump生成位置 */
+    PLASO_INIT_LOG_PATH: 'plaso-init-log-path',
+};
+
+/** 插入的文件类型 */
+const FILE_TYPE = {
+    PPT: 1,
+    IMAGE: 2,
+    PDF: 3,
+    WORD: 4,
+    EXCEL: 5,
+    AUDIO: 6,
+    VIDEO: 7,
+    DOC: 14,
+    XLS: 15,
+    ISPRINGPPT: 21,
+    PREPARE_LESSONS: 22,
+};
+
+module.exports = {
+    LESSON_TYPE,
+    ERROR_CODE,
+    CLASS_WINDOW_MESG_TYPE,
+    LEVEL,
+    RENDER_TO_MAIN_MESG_TYPE,
+    FILE_TYPE,
+};

package/js/main.js

@@ -1,34 +1,34 @@
-const isElectron = !!process.versions['electron'];
-if (isElectron) {
-    try {
-        require('@plasosdk/winproxy');
-        require('@plasosdk/screenshot');
-    } catch (error) {
-        console.error(error);
-    }
-    try {
-        const { RENDER_TO_MAIN_MESG_TYPE } = require('./macro');
-
-        const { app, ipcMain, crashReporter } = require('electron');
-
-        // 首次添加此开关是为了解决一些GPU导致的渲染问题的，比如进课堂白屏，历史课堂播放进度条不动。
-        // 支持虚拟声卡需要添加此开关
-        app.commandLine.appendSwitch('--no-sandbox');
-
-        ipcMain.on(RENDER_TO_MAIN_MESG_TYPE.PLASO_INIT_LOG_PATH, function (e, logFilePath) {
-            app.setPath('crashDumps', logFilePath);
-            crashReporter.start({ submitURL: '', uploadToServer: false });
-        });
-    } catch (e) {
-        console.error(e);
-    }
-}
-
-function initRemoteMain(remoteMain) {
-    const { initRemoteMain } = require('@plasosdk/winproxy');
-    if (remoteMain) initRemoteMain(remoteMain);
-}
-
-module.exports = {
-    initRemoteMain: initRemoteMain,
-};
+const isElectron = !!process.versions['electron'];
+if (isElectron) {
+    try {
+        require('@plasosdk/winproxy');
+        require('@plasosdk/screenshot');
+    } catch (error) {
+        console.error(error);
+    }
+    try {
+        const { RENDER_TO_MAIN_MESG_TYPE } = require('./macro');
+
+        const { app, ipcMain, crashReporter } = require('electron');
+
+        // 首次添加此开关是为了解决一些GPU导致的渲染问题的，比如进课堂白屏，历史课堂播放进度条不动。
+        // 支持虚拟声卡需要添加此开关
+        app.commandLine.appendSwitch('--no-sandbox');
+
+        ipcMain.on(RENDER_TO_MAIN_MESG_TYPE.PLASO_INIT_LOG_PATH, function (e, logFilePath) {
+            app.setPath('crashDumps', logFilePath);
+            crashReporter.start({ submitURL: '', uploadToServer: false });
+        });
+    } catch (e) {
+        console.error(e);
+    }
+}
+
+function initRemoteMain(remoteMain) {
+    const { initRemoteMain } = require('@plasosdk/winproxy');
+    if (remoteMain) initRemoteMain(remoteMain);
+}
+
+module.exports = {
+    initRemoteMain: initRemoteMain,
+};

package/js/render.d.ts

@@ -1,98 +1,100 @@
-export interface ClassOptionsType {
-    /** 是否开启课堂窗口debug模式 */
-    debug?: boolean;
-    /** 进课堂的必备query */
-    query: string;
-    /** 格式参考：1.53.901 */
-    version?: string;
-    env?: string;
-    appType?: string;
-    classType?: string;
-    topic?: string;
-    loginName?: string;
-    memoryConfigKey?: string;
-    /** 是否启用浏览器工具 */
-    enableBrowser?: boolean;
-    [key: string]: any;
-}
-
-export interface FileParams {
-    /** 备课文件本地地址 */
-    filePath: string[];
-    fileType: 'png' | 'pb' | string;
-}
-
-export interface ClassWindowType {
-    classOptions: ClassOptionsType;
-    /** 自定义electron的窗口参数 */
-    electronWinOptions?: object;
-    /** 课堂窗口打开渲染成功后的回调 */
-    onClassWindowReadyFn?: (winId: number) => void;
-    /** 课堂窗口关闭后的回调 */
-    onClassWindowLeaveFn?: (winId: number) => void;
-    /** 课堂结束后的回调 */
-    onClassFinishedFn?: (meetingId: string) => void;
-    /**
-     * 保存板书，具体的保存逻辑由外部实现。
-     * 取消保存板书时，callback 传 false，否则传 true
-     */
-    onSaveBoardFn?: (params: { fileInfo: FileParams[]; fileName?: string }, callback: (result: boolean) => void) => void;
-    /** 通知外部用户打开自己的资料中心 */
-    onOpenResourceCenterFn?: () => void;
-    /** 通过 insertObject 插入的文件时，从 info 中获取文件可访问地址 */
-    onGetExtFileNameFn?: (info: any, option: any) => Promise<string>;
-    /** 类似 onGetExtFileNameFn，获取的是预解析文件地址 */
-    onGetPreParseFileNameFn?: (info: any, option: { suffix: string }) => Promise<string>;
-    /** 上报问题，具体的上报逻辑由外部实现 */
-    onReportIssuesFn?: (info: { time: string; id: string; name: string; bugDescription: string }) => void;
-    /** 浏览器工具相关配置 */
-    browserOptions?: BrowserOptionsType;
-}
-
-type BrowserOptionsType = {
-    /** 获取自定义分类 */
-    onFetchCategoriesFn?: () => Promise<
-        | { success: true; data: { name: string; bookmarks: { title: string; url: string; icon: string }[] }[] }
-        | { success: false; message?: string }
-    >;
-    // 出于鉴权方面考量，收藏功能暂不对外
-    /** @deprecated 获取"我的收藏"列表 */
-    onFetchFavoritesFn?: () => Promise<
-        { success: true; data: { id: number; title: string; url: string; icon: string }[] } | { success: false; message?: string }
-    >;
-    /** @deprecated 添加收藏 */
-    onAddFavoriteFn?: (value: {
-        url: string;
-        title: string;
-    }) => Promise<
-        { success: true; data: { id: number; title: string; url: string; icon: string } } | { success: false; message?: string }
-    >;
-    /** @deprecated 删除收藏 */
-    onRemoveFavoriteFn?: (ids: number[]) => Promise<{ success: boolean; message?: string }>;
-};
-
-export interface FileDataObj {
-    /** 插入文件的格式，内容参考 FILE_TYPE */
-    type: number;
-    /** 文件名称，传入后会显示在文件窗口标题栏上，建议带上文件后缀名 */
-    title?: string;
-    /** 公开访问权限的文件全地址，建议 https 协议全地址 */
-    url?: string;
-    /** 具体的文件信息，除备课外，内容都由用户自己定义 */
-    info?: any[];
-}
-
-export type BuildReplyingCallback = <TArgs extends any[] = any[], TResult = any>(config: {
-    requestMsgType: string;
-    responseMsgType?: string;
-    /** 返回 false 时跳过后续流程 */
-    beforeCallback?: (...args: TArgs) => boolean | void;
-    /** 不传时跳过后续流程 */
-    callback?: (...args: TArgs) => TResult | Promise<TResult>;
-    /** 返回 false 时跳过后续流程 */
-    afterCallback?: (result: TResult) => boolean | void;
-}) => {
-    requestMsgType: string;
-    responseMsgType: string;
-    handler: (event: any, requestId: string, ...args: TArgs) => Promise<void>;
-};
+export interface ClassOptionsType {
+    /** 是否开启课堂窗口debug模式 */
+    debug?: boolean;
+    /** 进课堂的必备query */
+    query: string;
+    /** 格式参考：1.53.901 */
+    version?: string;
+    env?: string;
+    appType?: string;
+    classType?: string;
+    topic?: string;
+    loginName?: string;
+    memoryConfigKey?: string;
+    /** 是否启用浏览器工具 */
+    enableBrowser?: boolean;
+    /** 是否启用积分排行榜，0 关闭，1 开启 */
+    starShow?: number;
+    [key: string]: any;
+}
+
+export interface FileParams {
+    /** 备课文件本地地址 */
+    filePath: string[];
+    fileType: 'png' | 'pb' | string;
+}
+
+export interface ClassWindowType {
+    classOptions: ClassOptionsType;
+    /** 自定义electron的窗口参数 */
+    electronWinOptions?: object;
+    /** 课堂窗口打开渲染成功后的回调 */
+    onClassWindowReadyFn?: (winId: number) => void;
+    /** 课堂窗口关闭后的回调 */
+    onClassWindowLeaveFn?: (winId: number) => void;
+    /** 课堂结束后的回调 */
+    onClassFinishedFn?: (meetingId: string) => void;
+    /**
+     * 保存板书，具体的保存逻辑由外部实现。
+     * 取消保存板书时，callback 传 false，否则传 true
+     */
+    onSaveBoardFn?: (params: { fileInfo: FileParams[]; fileName?: string }, callback: (result: boolean) => void) => void;
+    /** 通知外部用户打开自己的资料中心 */
+    onOpenResourceCenterFn?: () => void;
+    /** 通过 insertObject 插入的文件时，从 info 中获取文件可访问地址 */
+    onGetExtFileNameFn?: (info: any, option: any) => Promise<string>;
+    /** 类似 onGetExtFileNameFn，获取的是预解析文件地址 */
+    onGetPreParseFileNameFn?: (info: any, option: { suffix: string }) => Promise<string>;
+    /** 上报问题，具体的上报逻辑由外部实现 */
+    onReportIssuesFn?: (info: { time: string; id: string; name: string; bugDescription: string }) => void;
+    /** 浏览器工具相关配置 */
+    browserOptions?: BrowserOptionsType;
+}
+
+type BrowserOptionsType = {
+    /** 获取自定义分类 */
+    onFetchCategoriesFn?: () => Promise<
+        | { success: true; data: { name: string; bookmarks: { title: string; url: string; icon: string }[] }[] }
+        | { success: false; message?: string }
+    >;
+    // 出于鉴权方面考量，收藏功能暂不对外
+    // /** @deprecated 获取"我的收藏"列表 */
+    // onFetchFavoritesFn?: () => Promise<
+    //     { success: true; data: { id: number; title: string; url: string; icon: string }[] } | { success: false; message?: string }
+    // >;
+    // /** @deprecated 添加收藏 */
+    // onAddFavoriteFn?: (value: {
+    //     url: string;
+    //     title: string;
+    // }) => Promise<
+    //     { success: true; data: { id: number; title: string; url: string; icon: string } } | { success: false; message?: string }
+    // >;
+    // /** @deprecated 删除收藏 */
+    // onRemoveFavoriteFn?: (ids: number[]) => Promise<{ success: boolean; message?: string }>;
+};
+
+export interface FileDataObj {
+    /** 插入文件的格式，内容参考 FILE_TYPE */
+    type: number;
+    /** 文件名称，传入后会显示在文件窗口标题栏上，建议带上文件后缀名 */
+    title?: string;
+    /** 公开访问权限的文件全地址，建议 https 协议全地址 */
+    url?: string;
+    /** 具体的文件信息，除备课外，内容都由用户自己定义 */
+    info?: any[];
+}
+
+export type BuildReplyingCallback = <TArgs extends any[] = any[], TResult = any>(config: {
+    requestMsgType: string;
+    responseMsgType?: string;
+    /** 返回 false 时跳过后续流程 */
+    beforeCallback?: (...args: TArgs) => boolean | void;
+    /** 不传时跳过后续流程 */
+    callback?: (...args: TArgs) => TResult | Promise<TResult>;
+    /** 返回 false 时跳过后续流程 */
+    afterCallback?: (result: TResult) => boolean | void;
+}) => {
+    requestMsgType: string;
+    responseMsgType: string;
+    handler: (event: any, requestId: string, ...args: TArgs) => Promise<void>;
+};