@plasosdk/plaso-electron-sdk 1.2.11 → 1.2.16

package/README.md

@@ -82,14 +82,31 @@ PlasoElectronSdk.initLogConfig(logFilePath);
 #### 1.2.3.4、[创建 课堂/备课 窗口](#5.3、createLiveClassWindow)
 
 ```ts
+interface CreateClassPamras {
+    classOptions: Object;
+    electronWinOptions?: Object;
+    onClassWindowReadyFn?: (winId: number) => void
+    onClassWindowLeaveFn?: (winId: number) => void
+    onClassFinishedFn?: (meetingId: string) => void;
+    onSaveBoardFn?: (
+        params: {
+            fileInfo: FileParams[];
+            fileName?: string;
+        },
+        callback: (result: boolean) => void,
+    ) => void;
+    onOpenResourceCenterFn?: () => void;
+    onGetExtFileNameFn?: (...args: any[]) => Promise<string>;
+}
+
 // 代码示例
 const PlasoElectronSdk = window.require('@plasosdk/plaso-electron-sdk');
-const classObj = {};
+const createClassParams: CreateClassPamras = { classOptions: { query } };
 
 //创建实时课堂
-PlasoElectronSdk.createLiveClassWindow(classObj);
+PlasoElectronSdk.createLiveClassWindow(createClassParams);
 // or 创建备课课堂
-PlasoElectronSdk.createPrepareClassWindow(classObj);
+PlasoElectronSdk.createPrepareClassWindow(createClassParams);
 ```
 
 # 2、实时课堂入参说明
@@ -111,7 +128,6 @@ PlasoElectronSdk.createPrepareClassWindow(classObj);
 | enableRTC3A | 否 | boolean | true | 是否启用 3A。<br />false：关闭回音消除、关闭降噪、关闭增益控制 |
 | supportShowResourceCenter | 否 | boolean | false | true：工具栏显示 资料中心 按钮，但资料中心的逻辑需要用户自己实现 |
 | supportSaveBoard | 否 | boolean | false | 是否支持保存板书，依赖于资料中心实现保存和插入板书文件 |
-| env | 否 | string | 无 | sdk 数据环境参数，支持 dev、test、itest、ftest、www |
 | enableLiveNewShareRegion | 否 | boolean | false | 是否允许区域共享 |
 | enableLiveNewShareInTouch | 否 | boolean | false | 是否支持触屏模式下的新桌面共享（左侧新增按钮窗口来切换显示工具栏）<br />建议开启 |
 | enableLiveNewShare | 否 | boolean | false | 是否支持新桌面共享<br />开启新桌面共享需要开启 electron 透明窗口,且可能触发 electron 本身存在的长时间透传导致的在应用上鼠标失焦问题 |
@@ -124,7 +140,7 @@ PlasoElectronSdk.createPrepareClassWindow(classObj);
 **query 属性格式示例**：
 
 ```
-appId=plaso&appType=liveclassSDK&d_dimension=1280x720&dhost=https%3A%2F%2Fdev.plaso.cn%2F&enableHiliter=true&enableNewClassExam=1&enableVideoMark=true&env=dev&loginName=t_1&mediaType=video&meetingId=test_1742442362&meetingType=public&**signature**=A226198904A392579B98987FB4CD5478AB3F5587&upimeTeacherTool=1151&userName=%E8%80%81%E5%B8%881&userType=speaker&validBegin=1742442364&validTime=99999&vendorType=2&videoStream=2'
+appId=plaso&appType=liveclassSDK&d_dimension=1280x720&dhost=https%3A%2F%2Fdev.plaso.cn%2F&enableHiliter=true&enableNewClassExam=1&enableVideoMark=true&loginName=t_1&mediaType=video&meetingId=test_1742442362&meetingType=public&signature=A226198904A392579B98987FB4CD5478AB3F5587&upimeTeacherTool=1151&userName=%E8%80%81%E5%B8%881&userType=speaker&validBegin=1742442364&validTime=99999&vendorType=2&videoStream=2
 ```
 
 #### 2.1.1.1、组成 queryParams 对象
@@ -132,6 +148,7 @@ appId=plaso&appType=liveclassSDK&d_dimension=1280x720&dhost=https%3A%2F%2Fdev.pl
 ```ts
 interface IQueryParams {
     appId: string;
+    signature: string;
     validBegin: number;
     validTime: number;
     endTime: number;
@@ -168,6 +185,7 @@ interface IQueryParams {
 | 参数 | 类型 | 说明 |
 | --- | --- | --- |
 | appId | string | 在申请接入时，伯索平台给予的 appId |
+| signature | string | 签名字符串，根据queryParams中除去signature参数的其他参数生成，生成示例参考[根据queryParams对象生成签名字符串](#2112根据-queryParams-对象生成签名字符串) |
 | validBegin | number | 请求课堂**开始生效起始时间**的 Unix Epoch 时间戳，单位秒：（时间戳/1000 再取整） |
 | validTime | number | 请求的**签名在课堂的有效时间段**（断网重连后会重新校验签名），单位秒，建议: 24 _ 60 _ 60 s |
 | endTime | number | 请求课堂**结束时间**的 Unix Epoch 时间戳，单位秒：（时间戳/1000 再取整） |
@@ -268,13 +286,6 @@ function genQuery(queryParams) {
 genQuery(queryParams);
 ```
 
-## 2.2、课堂结束的回调 onClassFinishedFn
-
-```ts
-// 课堂结束后的回调，回调参数为 课堂的meetingId
-(meetingId: string) => void
-
-```
 
 # 3、备课课堂入参说明
 
@@ -289,7 +300,7 @@ genQuery(queryParams);
 | 参数      | 类型   | 说明                                                                                 |
 | --------- | ------ | ------------------------------------------------------------------------------------ |
 | loginName | String | **唯一标识该用户的 id**，不能为空，相同的 loginName 登录，后面一个会使前面一个登出； |
-| username  | String | 登录的用户名，在列表中显示用                                                         |
+| userName  | String | 登录的用户名，在列表中显示用                                                         |
 |           |        |                                                                                      |
 
 ### 3.1.2、可选参数
@@ -299,7 +310,6 @@ genQuery(queryParams);
 | displayAvatarUrl | String | 用户头像地址 |
 | topic | String | 默认值是中文的 “备课课堂” |
 | **d_enableObjectEraser** | number | 新板书配置，二进制位存储<br />default: 0；默认关闭对象擦<br />7:手写(对象擦);<br />**注意：该值需要和实时课堂的传值一样** |
-| env | String | sdk 数据环境参数，支持：dev、test、itest、ftest、www |
 |  |  |  |
 
 **注意：**
@@ -330,7 +340,15 @@ type onClassWindowReadyFn = (winId: number) => void;
 type onClassWindowLeaveFn = (winId: number) => void;
 ```
 
-## 4.4、参数回调 onSaveBoardFn
+## 4.4、参数回调 onClassFinishedFn
+
+```ts
+// 课堂结束后的回调，回调参数为 课堂的meetingId
+type onClassFinishedFn = (meetingId: string) => void;
+
+```
+
+## 4.5、参数回调 onSaveBoardFn
 
 **注意：**
 
@@ -359,18 +377,16 @@ type onSaveBoardFn = (
 ) => void;
 ```
 
-fileInfo 格式如下：
-
-![img](./image/备课1.png)
-
-## 4.5、参数回调 onOpenResourceCenterFn
+## 4.6、参数回调 onOpenResourceCenterFn
 
 ```ts
 // 通知外部用户打开自己的资料中心，资料中心的具体ui和逻辑由外部用户自己实现
+// 推荐：通过onClassWindowReadyFn回调的winId拿到课堂窗口实例，用户的云盘通过一个BrowserWindow
+// 和课堂窗口组成父子窗口，云盘是子窗口，并且云盘窗口打开时保持置顶，这样来保证云盘打开时始终可见并且跟随课堂窗口。
 type onOpenResourceCenterFn = () => void;
 ```
 
-## 4.6、参数回调 onGetExtFileNameFn
+## 4.7、参数回调 onGetExtFileNameFn
 
 ```ts
 // 通过 insertObject 插入的文件传入 参数 info 时，怎么从info中获取文件的可访问地址的逻辑在用户那，所以需要函数从外部用户获取外部用户传入的文件地址
@@ -522,10 +538,9 @@ const FILE_TYPE = {
  * @property {string} [url] 文件的可下载地址
  */
 /**
- * @param {string | number} winId 课堂id
  * @param {fileDataObj} fileData 文件数据
  */
-type insertObject = (webContentId, fileData) => void;
+type insertObject = (fileData) => void;
 ```
 
 ### 5.5.1、插入备课文件

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@plasosdk/plaso-electron-sdk",
-  "version": "1.2.11",
-  "description": "",
+  "version": "1.2.16",
+  "description": "伯索课堂Electron SDK",
   "main": "index.js",
   "scripts": {
     "start": "electron .",
@@ -9,9 +9,10 @@
     "download": "node ./scripts/downloadPrebuild.js"
   },
   "keywords": [
+    "plaso",
+    "sdk",
     "electron",
-    "windows",
-    "mac"
+    "classroom"
   ],
   "dependencies": {
     "@plasosdk/plasoffmpeg": "^1.1.0",

package/publish.js

@@ -0,0 +1,312 @@
+#!/usr/bin/env node
+
+/**
+ * Plaso SDK 发布脚本
+ * 
+ * 功能:
+ * - 自动升级版本号(major/minor/patch)
+ * - 检查登录状态
+ * - 发布包
+ * 
+ * 使用方法:
+ * - 基本用法: npm run release
+ *   (无参数时会进入交互模式，询问是否跳过版本升级)
+ * - 跳过版本升级(推荐): npm run release-skip
+ * - 跳过版本升级(手动传参): npm run release -- --skip-version-upgrade
+ * - 跳过版本升级(简写): npm run release -- -s
+ * 
+ * 注意:
+ * - 使用跳过版本选项时，会检查当前版本是否已发布，如已发布会提示确认
+ * - 如果您手动修改了版本号，建议使用跳过版本升级选项
+ * - 此脚本假设您已经手动设置了正确的npm源，不会自动切换源
+ */
+
+const { execSync } = require('child_process');
+const readline = require('readline');
+const fs = require('fs');
+const path = require('path');
+
+// 创建readline接口
+const rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout
+});
+
+// 添加跨平台休眠函数
+function sleep(seconds) {
+  // 根据操作系统选择合适的休眠方法
+  const isWindows = process.platform === 'win32';
+  
+  try {
+    if (isWindows) {
+      // Windows 使用 timeout 命令
+      execSync(`timeout /t ${seconds}`, { stdio: 'ignore' });
+    } else {
+      // Unix 系统使用 sleep 命令
+      execSync(`sleep ${seconds}`, { stdio: 'ignore' });
+    }
+  } catch (error) {
+    // 如果命令执行失败，使用JavaScript的setTimeout作为备选
+    console.log(`系统休眠命令失败，使用JavaScript休眠 ${seconds} 秒`);
+    const start = Date.now();
+    while (Date.now() - start < seconds * 1000) {
+      // 空循环等待
+    }
+  }
+}
+
+// 执行命令的函数
+function executeCommand(command) {
+  try {
+    execSync(command, { stdio: 'inherit' });
+    return true;
+  } catch (error) {
+    // 检查是否是版本已存在的错误
+    if (error.message.includes('You cannot publish over the previously published versions')) {
+      console.log('\n该版本已经发布过了，无需重复发布');
+      return true;
+    }
+    console.error(`执行命令失败: ${command}`);
+    console.error(error.message);
+    return false;
+  }
+}
+
+// 检查npm登录状态
+function checkNpmLoginStatus() {
+  try {
+    // 直接使用npm命令而不是npx
+    const output = execSync('npm whoami', { encoding: 'utf8' });
+    const username = output.trim();
+    if (username.length > 0) {
+      console.log(`当前登录用户: ${username}`);
+      return true;
+    }
+    return false;
+  } catch (error) {
+    console.log('npm登录状态检查失败，您可能尚未登录');
+    return false;
+  }
+}
+
+// 确保npm登录
+async function ensureNpmLogin() {
+  console.log('\n检查npm登录状态...');
+  
+  // 检查登录状态
+  const isLoggedIn = checkNpmLoginStatus();
+  if (!isLoggedIn) {
+    console.log('未登录，开始登录流程...');
+    
+    // 登录命令
+    const loginCmd = 'npm login';
+    if (!executeCommand(loginCmd)) {
+      throw new Error('npm登录失败');
+    }
+    
+    // 再次检查登录状态
+    if (!checkNpmLoginStatus()) {
+      throw new Error('登录失败，请重试');
+    }
+    
+    console.log('登录成功!');
+    return true;
+  } else {
+    console.log('已经登录，跳过登录步骤');
+    return true;
+  }
+}
+
+// 提示用户输入
+function prompt(question) {
+  return new Promise((resolve) => {
+    rl.question(question, (answer) => {
+      resolve(answer);
+    });
+  });
+}
+
+// 读取package.json文件
+function readPackageJson() {
+  const packagePath = path.join(process.cwd(), 'package.json');
+  const packageContent = fs.readFileSync(packagePath, 'utf8');
+  return JSON.parse(packageContent);
+}
+
+// 写入package.json文件
+function writePackageJson(packageJson) {
+  const packagePath = path.join(process.cwd(), 'package.json');
+  fs.writeFileSync(packagePath, JSON.stringify(packageJson, null, 2) + '\n');
+}
+
+// 升级版本号
+function upgradeVersion(currentVersion, type) {
+  const [major, minor, patch] = currentVersion.split('.').map(Number);
+  
+  switch (type) {
+    case 'major':
+      return `${major + 1}.0.0`;
+    case 'minor':
+      return `${major}.${minor + 1}.0`;
+    case 'patch':
+    default:
+      return `${major}.${minor}.${patch + 1}`;
+  }
+}
+
+// 检查版本是否已发布
+async function checkVersionExists(packageName, version) {
+  try {
+    console.log(`检查版本 ${packageName}@${version} 是否已发布...`);
+    const cmd = `npx npm view ${packageName}@${version} version --json`;
+    
+    try {
+      execSync(cmd, { stdio: 'ignore' });
+      console.log(`版本 ${version} 已存在于npm仓库`);
+      return true;
+    } catch (e) {
+      // 如果命令执行失败，通常意味着版本不存在
+      console.log(`版本 ${version} 不存在于npm仓库，可以发布`);
+      return false;
+    }
+  } catch (error) {
+    console.error('检查版本失败:', error.message);
+    // 发生错误时，默认允许继续（让npm publish时再判断）
+    return false;
+  }
+}
+
+// 解析命令行参数
+function parseArgs() {
+  const args = process.argv.slice(2);
+  const options = {
+    skipVersionUpgrade: false,
+    interactive: args.length === 0  // 如果没有传入参数，则启用交互模式
+  };
+  
+  for (let i = 0; i < args.length; i++) {
+    const arg = args[i];
+    if (arg === '--skip-version-upgrade' || arg === '-s') {
+      options.skipVersionUpgrade = true;
+    }
+  }
+  
+  return options;
+}
+
+async function main() {
+  // 解析命令行参数
+  const options = parseArgs();
+  
+  try {
+    console.log('开始发布SDK...');
+
+    // 交互模式：如果没有传入命令行参数，则询问是否要跳过版本升级
+    if (options.interactive) {
+      const skipVersionAnswer = await prompt('是否跳过版本升级? (y/n): ');
+      if (skipVersionAnswer.toLowerCase() === 'y') {
+        options.skipVersionUpgrade = true;
+        console.log('已选择跳过版本升级');
+      }
+    }
+
+    // 0. 升级版本号
+    console.log('\n0. 升级版本号...');
+    const packageJson = readPackageJson();
+    const currentVersion = packageJson.version;
+    let newVersion;
+    
+    // 如果命令行参数指定跳过版本升级
+    if (options.skipVersionUpgrade) {
+      console.log('检测到--skip-version-upgrade参数，跳过版本升级');
+      newVersion = currentVersion;
+    } else {
+      console.log(`当前版本: ${currentVersion}`);
+      console.log('请选择版本升级类型:');
+      console.log('1. major - 主版本号升级 (不兼容的API变更)');
+      console.log('2. minor - 次版本号升级 (向后兼容的功能性新增)');
+      console.log('3. patch - 修订号升级 (向后兼容的问题修正)');
+      console.log('4. skip - 跳过版本升级，保持当前版本');
+      
+      const versionType = await prompt('请输入选项 (1/2/3/4，默认为3): ');
+      let type;
+      
+      switch (versionType.trim()) {
+        case '1':
+          type = 'major';
+          newVersion = upgradeVersion(currentVersion, type);
+          break;
+        case '2':
+          type = 'minor';
+          newVersion = upgradeVersion(currentVersion, type);
+          break;
+        case '4':
+          console.log('已选择跳过版本升级');
+          newVersion = currentVersion;
+          break;
+        case '3':
+        default:
+          type = 'patch';
+          newVersion = upgradeVersion(currentVersion, type);
+          break;
+      }
+    }
+    
+    console.log(`版本: ${newVersion}`);
+    
+    // 如果版本没有变化，直接询问是否确认发布
+    const confirmMessage = newVersion === currentVersion 
+      ? `确认发布当前版本 ${currentVersion}? (y/n): `
+      : `确认将版本从 ${currentVersion} 升级到 ${newVersion}? (y/n): `;
+    
+    const confirm = await prompt(confirmMessage);
+    if (confirm.toLowerCase() !== 'y') {
+      console.log('已取消发布');
+      return;
+    }
+    
+    // 只有当版本变化时才写入package.json
+    if (newVersion !== currentVersion) {
+      packageJson.version = newVersion;
+      writePackageJson(packageJson);
+      console.log(`版本已更新为 ${newVersion}`);
+    } else {
+      console.log(`继续使用当前版本 ${currentVersion}`);
+      
+      // 当用户选择继续使用当前版本时，检查该版本是否已发布
+      const versionExists = await checkVersionExists(packageJson.name, currentVersion);
+      if (versionExists) {
+        console.log(`\n警告: 版本 ${currentVersion} 已经发布，继续操作会失败。`);
+        const forceContinue = await prompt('是否仍要继续? (y/n): ');
+        if (forceContinue.toLowerCase() !== 'y') {
+          console.log('已取消发布');
+          return;
+        }
+        console.log('用户选择强制继续，可能会在发布时报错');
+      }
+    }
+
+    // 1. 确保登录
+    console.log('\n1. 检查登录状态...');
+    if (!await ensureNpmLogin()) {
+      throw new Error('登录失败');
+    }
+
+    // 2. 发布包
+    console.log('\n2. 开始发布包...');
+    const publishCmd = 'npm publish --ignore-scripts';
+    if (!executeCommand(publishCmd)) {
+      throw new Error('发布包失败');
+    }
+    
+    console.log(`\n恭喜！${packageJson.name}@${newVersion} 已成功发布到npm！`);
+
+  } catch (error) {
+    console.error('\n发布失败:', error.message);
+    process.exit(1);
+  } finally {
+    rl.close();
+  }
+}
+
+main();