jjb-h5-supervision-sdk 0.0.1

package/dist/index.js.LICENSE.txt

@@ -0,0 +1,18 @@
+/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/babel/babel/blob/main/packages/babel-helpers/LICENSE */
+
+/** @preserve
+	 * Counter block mode compatible with  Dr Brian Gladman fileenc.c
+	 * derived from CryptoJS.mode.CTR
+	 * Jan Hruby jhruby.web@gmail.com
+	 */
+
+/** @preserve
+	(c) 2012 by Cédric Mesnil. All rights reserved.
+
+	Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+	    - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+	    - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+	*/

package/package.json

@@ -0,0 +1 @@
+{"name":"jjb-h5-supervision-sdk","version":"0.0.1","description":"点播/直播课程学习监管SDK","main":"dist/index.js","author":"1042656836@qq.com | jiaoxiwei","license":"MIT","typings":"types/index.d.ts","dependencies":{"crypto-js":"^4.1.1"}}

package/types/index.d.ts

@@ -0,0 +1,141 @@
+// Modify-date 2026/01/01
+
+export = JJB_H5_SUPERVISION_SDK;
+export as namespace JJB_H5_SUPERVISION_SDK;
+
+/**
+   * @description 在线测评监听器
+   */
+class ExamObserve {
+  private _currentTime: number;
+  private _currentTimeCallback: () => void;
+
+  constructor();
+
+  get currentTime(): number;
+  set currentTime(value: number);
+
+  pause(): void;
+
+  addEventListener(type: 'timeupdate', callback: () => void): void;
+
+  removeEventListener(type: 'timeupdate'): void;
+}
+
+interface InitOption {
+  // 是否开启日志输出
+  log?: boolean;
+  // 接口网关地址
+  host: string;
+  // 播放器-原生媒体元素，或以原生媒体元素开发的第三方插件 | 测评监听模拟器
+  player?: HTMLMediaElement | ExamObserve;
+
+  // 控制
+  readonly controls?: {
+    // 禁用断开提示，默认true
+    disabledDisconnectTip: boolean;
+  }
+
+  /**
+   * @description 初始化监听配置
+   * @doc http://opendoc.jjbedu.cn/index.html#init:listener
+   */
+  readonly listener?: {
+    // 监听-可选配置项-首次验证结束
+    onFirstValidateEnd (e: Event): void;
+    // 监听-可选配置项-首次验证开始
+    onFirstValidateStart (e: Event): void;
+    // 监听-可选配置项-SDK已销毁
+    onDestroyedHandler (e: Event): void;
+    // 监听-可选配置项-SDK连接服务器-成功
+    onConnectHandler (e: Event): void;
+    // 监听-可选配置项-SDK连接服务器-错误
+    onConnectErrorHandler (e: Event): void;
+    // 监听-可选配置项-SDK与服务器-断开连接
+    onDisconnectHandler (e: Event): void;
+    // 监听-可选配置项-SDK数据响应拦截器，包含socket和xhr响应数据
+    onResponseIntercept (res: { data: Record<string, any>, method?: string, response?: Record<string, any>, type: 'xhr' | 'socket', url?: string }): void;
+    // 监听-可选配置项-SDK断开重启，disabledDisconnectTip属性为true有效
+    onRestart (data: { lastSeconds: number }): void;
+  };
+
+  /**
+   * @description 初始化基本字段
+   * @doc http://opendoc.jjbedu.cn/index.html#studyInfos
+   */
+  readonly studyInfos: {
+    readonly app_key: string;
+    readonly train_type_enum: 'SEND_JXJY' | 'SEND_GQPX';
+    readonly course_type_enum: 'DEMAND' | 'LIVE';
+    readonly credit_status_enum: 'TRUE' | 'FALSE';
+    readonly [ p: string ]: string;
+  };
+}
+
+/**
+ * @description 运行过程中的验证生命周期类型
+ * @doc http://opendoc.jjbedu.cn/index.html#Context
+ */
+interface MessageType {
+  // SDK-已准备
+  IS_READY: string;
+  // SDK-学习完成
+  IS_COMPLETE: string;
+  // SDK-验证规则激活
+  VERIFY_LIFE_CYCLE_RULE_ACTIVE: string;
+  // SDK-验证规则进入
+  VERIFY_LIFE_CYCLE_RULE_ENTER: string;
+  // SDK-验证规则开始
+  VERIFY_LIFE_CYCLE_RULE_START: string;
+  // SDK-验证规则结束
+  VERIFY_LIFE_CYCLE_RULE_END: string;
+  // SDK-验证规则退出
+  VERIFY_LIFE_CYCLE_RULE_EXIT: string;
+}
+
+/**
+ * @description SDK初始化实例对象
+ * @doc http://opendoc.jjbedu.cn/index.html#Context
+ */
+interface InitInstance {
+  /**
+   * 是否需要弹出验证 true | false
+   */
+  popupStatus: boolean;
+
+  /**
+   * @description 监听消息
+   * @param callback
+   */
+  onMessage: (res: { type: string, lastSeconds: number, sections: {}[], report: boolean }) => void;
+}
+
+/**
+ * @description SDK内置API
+ * @doc http://opendoc.jjbedu.cn/index.html#API
+ */
+declare namespace JJB_H5_SUPERVISION_SDK {
+  /**
+   * @description 初始化SDK
+   * @param option 初始化配置项
+   * @param getContext 初始化成功的上下文回调
+   * @doc https://opendoc.jjbedu.cn/index.html
+   */
+  function init (option: InitOption, getContext?: (context: InitInstance) => void): void;
+
+  /**
+   * @description 检查SDK运行状态
+   */
+  function check (): boolean;
+
+  /**
+   * @description 打印版本号
+   */
+  function version (): string;
+
+  /**
+   * @description 手动销毁SDK
+   * @param callback 销毁完成回调
+   */
+  function destroy (callback?: () => void): void;
+}