fcr-core 3.8.2 → 3.9.0-alpha

package/lib/room-control/whiteboard-control-v2/base/main-window.js

@@ -33,7 +33,8 @@ var _schema = require("agora-foundation/lib/utilities/schema");
 var _validateParams = _interopRequireDefault(require("../../../utilities/validate-params"));
 var _schema2 = require("../../../schema");
 var _decorator = require("agora-foundation/lib/decorator");
-let _initProto, _setBackgroundColorDecs, _setToolTypeDecs, _setStrokeWidthDecs, _setStrokeColorDecs, _setTextColorDecs, _setTextSizeDecs, _insertImageDecs, _setContainerSizeRatioDecs, _setBoardTransparentDecs, _updateWindowSizeDecs, _setAutoCancelDrawDecs;
+var _type = require("../../../type");
+let _initProto, _setBackgroundColorDecs, _setToolTypeDecs, _setStrokeWidthDecs, _setStrokeColorDecs, _setTextColorDecs, _setTextSizeDecs, _insertImageDecs, _setContainerSizeRatioDecs, _setBoardTransparentDecs, _updateWindowSizeDecs, _setAutoCancelDrawDecs, _handleApplicationLaunchDecs, _handleApplicationTerminalDecs, _enableAutoCancelDecs;
 function _applyDecs(e, t, r, n, o, a) { function i(e, t, r) { return function (n, o) { return r && r(n), e[t].call(n, o); }; } function c(e, t) { for (var r = 0; r < e.length; r++) e[r].call(t); return t; } function s(e, t, r, n) { if ("function" != typeof e && (n || void 0 !== e)) throw new TypeError(t + " must " + (r || "be") + " a function" + (n ? "" : " or undefined")); return e; } function applyDec(e, t, r, n, o, a, c, u, l, f, p, d, h) { function m(e) { if (!h(e)) throw new TypeError("Attempted to access private element on non-instance"); } var y, v = t[0], g = t[3], b = !u; if (!b) { r || Array.isArray(v) || (v = [v]); var w = {}, S = [], A = 3 === o ? "get" : 4 === o || d ? "set" : "value"; f ? (p || d ? w = { get: _setFunctionName(function () { return g(this); }, n, "get"), set: function (e) { t[4](this, e); } } : w[A] = g, p || _setFunctionName(w[A], n, 2 === o ? "" : A)) : p || (w = Object.getOwnPropertyDescriptor(e, n)); } for (var P = e, j = v.length - 1; j >= 0; j -= r ? 2 : 1) { var D = v[j], E = r ? v[j - 1] : void 0, I = {}, O = { kind: ["field", "accessor", "method", "getter", "setter", "class"][o], name: n, metadata: a, addInitializer: function (e, t) { if (e.v) throw Error("attempted to call addInitializer after decoration was finished"); s(t, "An initializer", "be", !0), c.push(t); }.bind(null, I) }; try { if (b) (y = s(D.call(E, P, O), "class decorators", "return")) && (P = y);else { var k, F; O.static = l, O.private = f, f ? 2 === o ? k = function (e) { return m(e), w.value; } : (o < 4 && (k = i(w, "get", m)), 3 !== o && (F = i(w, "set", m))) : (k = function (e) { return e[n]; }, (o < 2 || 4 === o) && (F = function (e, t) { e[n] = t; })); var N = O.access = { has: f ? h.bind() : function (e) { return n in e; } }; if (k && (N.get = k), F && (N.set = F), P = D.call(E, d ? { get: w.get, set: w.set } : w[A], O), d) { if ("object" == typeof P && P) (y = s(P.get, "accessor.get")) && (w.get = y), (y = s(P.set, "accessor.set")) && (w.set = y), (y = s(P.init, "accessor.init")) && S.push(y);else if (void 0 !== P) throw new TypeError("accessor decorators must return an object with get, set, or init properties or void 0"); } else s(P, (p ? "field" : "method") + " decorators", "return") && (p ? S.push(P) : w[A] = P); } } finally { I.v = !0; } } return (p || d) && u.push(function (e, t) { for (var r = S.length - 1; r >= 0; r--) t = S[r].call(e, t); return t; }), p || b || (f ? d ? u.push(i(w, "get"), i(w, "set")) : u.push(2 === o ? w[A] : i.call.bind(w[A])) : Object.defineProperty(e, n, w)), P; } function u(e, t) { return Object.defineProperty(e, Symbol.metadata || Symbol.for("Symbol.metadata"), { configurable: !0, enumerable: !0, value: t }); } if (arguments.length >= 6) var l = a[Symbol.metadata || Symbol.for("Symbol.metadata")]; var f = Object.create(null == l ? null : l), p = function (e, t, r, n) { var o, a, i = [], s = function (t) { return _checkInRHS(t) === e; }, u = new Map(); function l(e) { e && i.push(c.bind(null, e)); } for (var f = 0; f < t.length; f++) { var p = t[f]; if (Array.isArray(p)) { var d = p[1], h = p[2], m = p.length > 3, y = 16 & d, v = !!(8 & d), g = 0 == (d &= 7), b = h + "/" + v; if (!g && !m) { var w = u.get(b); if (!0 === w || 3 === w && 4 !== d || 4 === w && 3 !== d) throw Error("Attempted to decorate a public method/accessor that has the same name as a previously decorated public method/accessor. This is not currently supported by the decorators plugin. Property name was: " + h); u.set(b, !(d > 2) || d); } applyDec(v ? e : e.prototype, p, y, m ? "#" + h : _toPropertyKey(h), d, n, v ? a = a || [] : o = o || [], i, v, m, g, 1 === d, v && m ? s : r); } } return l(o), l(a), i; }(e, t, o, f); return r.length || u(e, f), { e: p, get c() { var t = []; return r.length && [u(applyDec(e, [r], n, e.name, 5, f, t), f), c.bind(null, t, e)]; } }; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
@@ -41,9 +42,9 @@ function _setFunctionName(e, t, n) { "symbol" == typeof t && (t = (t = t.descrip
 function _checkInRHS(e) { if (Object(e) !== e) throw TypeError("right-hand side of 'in' should be an object, got " + (null !== e ? typeof e : "null")); return e; }
 class FcrBoardMainWindowImpl {
   static {
-    [_initProto] = _applyDecs(this, [[_log.trace, 2, "addPage"], [_log.trace, 2, "removePage"], [_log.trace, 2, "undo"], [_log.trace, 2, "redo"], [_log.trace, 2, "clean"], [_log.trace, 2, "getSnapshotImage"], [_setBackgroundColorDecs, 2, "setBackgroundColor"], [_log.trace, 2, "getPageInfo"], [_log.trace, 2, "prevPage"], [_log.trace, 2, "nextPage"], [_setToolTypeDecs, 2, "setToolType"], [_setStrokeWidthDecs, 2, "setStrokeWidth"], [_setStrokeColorDecs, 2, "setStrokeColor"], [_setTextColorDecs, 2, "setTextColor"], [_setTextSizeDecs, 2, "setTextSize"], [_insertImageDecs, 2, "insertImage"], [_log.trace, 2, "getContentView"], [_setContainerSizeRatioDecs, 2, "setContainerSizeRatio"], [_setBoardTransparentDecs, 2, "setBoardTransparent"], [_updateWindowSizeDecs, 2, "updateWindowSize"], [_setAutoCancelDrawDecs, 2, "setAutoCancelDraw"], [_log.trace, 2, "getWritable"], [[_decorator.bound, _log.trace], 2, "_handleApplicationLaunch"], [[_decorator.bound, _log.trace], 2, "_handleApplicationTerminal"], [_log.trace, 2, "_enableAutoCancel"]], []).e;
+    [_initProto] = _applyDecs(this, [[_log.trace, 2, "addPage"], [_log.trace, 2, "removePage"], [_log.trace, 2, "undo"], [_log.trace, 2, "redo"], [_log.trace, 2, "clean"], [_log.trace, 2, "getSnapshotImage"], [_setBackgroundColorDecs, 2, "setBackgroundColor"], [_log.trace, 2, "getPageInfo"], [_log.trace, 2, "prevPage"], [_log.trace, 2, "nextPage"], [_setToolTypeDecs, 2, "setToolType"], [_setStrokeWidthDecs, 2, "setStrokeWidth"], [_setStrokeColorDecs, 2, "setStrokeColor"], [_setTextColorDecs, 2, "setTextColor"], [_setTextSizeDecs, 2, "setTextSize"], [_insertImageDecs, 2, "insertImage"], [_log.trace, 2, "getContentView"], [_setContainerSizeRatioDecs, 2, "setContainerSizeRatio"], [_setBoardTransparentDecs, 2, "setBoardTransparent"], [_updateWindowSizeDecs, 2, "updateWindowSize"], [_setAutoCancelDrawDecs, 2, "setAutoCancelDraw"], [_log.trace, 2, "getWritable"], [_handleApplicationLaunchDecs, 2, "_handleApplicationLaunch"], [_handleApplicationTerminalDecs, 2, "_handleApplicationTerminal"], [_enableAutoCancelDecs, 2, "_enableAutoCancel"]], []).e;
   }
-  [(_setBackgroundColorDecs = [_log.trace, (0, _validateParams.default)(_schema.stringSchema)], _setToolTypeDecs = [_log.trace, (0, _validateParams.default)(_schema2.fcrBoardToolTypeSchema)], _setStrokeWidthDecs = [_log.trace, (0, _validateParams.default)(_schema2.numberSchema)], _setStrokeColorDecs = [_log.trace, (0, _validateParams.default)(_schema2.z.union([_schema2.colorSchema, _schema.stringSchema]))], _setTextColorDecs = [_log.trace, (0, _validateParams.default)(_schema2.colorSchema)], _setTextSizeDecs = [_log.trace, (0, _validateParams.default)(_schema2.numberSchema)], _insertImageDecs = [_log.trace, (0, _validateParams.default)(_schema.stringSchema, _schema2.numberSchema, _schema2.numberSchema, _schema2.numberSchema, _schema2.numberSchema)], _setContainerSizeRatioDecs = [_log.trace, (0, _validateParams.default)(_schema2.numberSchema)], _setBoardTransparentDecs = [_log.trace, (0, _validateParams.default)(_schema2.booleanSchema)], _updateWindowSizeDecs = [_log.trace, (0, _validateParams.default)(_schema2.fcrSizeSchema)], _setAutoCancelDrawDecs = [_log.trace, (0, _validateParams.default)(_schema2.booleanSchema)], "logger")] = (_initProto(this), (0, _logger.createLogger)({
+  [(_setBackgroundColorDecs = [(0, _log.trace)(['color']), (0, _validateParams.default)(_schema.stringSchema)], _setToolTypeDecs = [(0, _log.trace)(['type']), (0, _validateParams.default)(_schema2.fcrBoardToolTypeSchema)], _setStrokeWidthDecs = [(0, _log.trace)(['strokeWidth']), (0, _validateParams.default)(_schema2.numberSchema)], _setStrokeColorDecs = [(0, _log.trace)(['color']), (0, _validateParams.default)(_schema2.z.union([_schema2.colorSchema, _schema.stringSchema]))], _setTextColorDecs = [(0, _log.trace)(['color']), (0, _validateParams.default)(_schema2.colorSchema)], _setTextSizeDecs = [(0, _log.trace)(['textSize']), (0, _validateParams.default)(_schema2.numberSchema)], _insertImageDecs = [(0, _log.trace)(['resourceUrl', 'x', 'y', 'width', 'height']), (0, _validateParams.default)(_schema.stringSchema, _schema2.numberSchema, _schema2.numberSchema, _schema2.numberSchema, _schema2.numberSchema)], _setContainerSizeRatioDecs = [(0, _log.trace)(['ratio']), (0, _validateParams.default)(_schema2.numberSchema)], _setBoardTransparentDecs = [(0, _log.trace)(['isTransparent']), (0, _validateParams.default)(_schema2.booleanSchema)], _updateWindowSizeDecs = [(0, _log.trace)(['size']), (0, _validateParams.default)(_schema2.fcrSizeSchema)], _setAutoCancelDrawDecs = [(0, _log.trace)(['enable']), (0, _validateParams.default)(_schema2.booleanSchema)], _handleApplicationLaunchDecs = [_decorator.bound, (0, _log.trace)(['appId', 'app'])], _handleApplicationTerminalDecs = [_decorator.bound, (0, _log.trace)(['appId', 'app'])], _enableAutoCancelDecs = (0, _log.trace)(['enable']), "logger")] = (_initProto(this), (0, _logger.createLogger)({
     prefix: 'FcrBoardMainWindowImpl'
   }));
   _observable = new _observable.AgoraObservable();
@@ -69,18 +70,23 @@ class FcrBoardMainWindowImpl {
   }
   async addPage() {
     this._whiteboard.addPage('next');
+    return _type.FcrReturnCode.SUCCESS;
   }
   async removePage() {
     this._whiteboard.deletePage('current');
+    return _type.FcrReturnCode.SUCCESS;
   }
   async undo() {
     this._whiteboard.undo();
+    return _type.FcrReturnCode.SUCCESS;
   }
   async redo() {
     this._whiteboard.redo();
+    return _type.FcrReturnCode.SUCCESS;
   }
   async clean() {
     this._whiteboard.clearPage();
+    return _type.FcrReturnCode.SUCCESS;
   }
   async getSnapshotImage() {
     if (this._whiteboard) {
@@ -114,6 +120,7 @@ class FcrBoardMainWindowImpl {
     this._background = color;
     this.logger.info(`set canvas background color: ${this._background}`);
     this._whiteboard.setCanvasBackgroundColor(color);
+    return _type.FcrReturnCode.SUCCESS;
   }
   getPageInfo() {
     return {
@@ -123,9 +130,11 @@ class FcrBoardMainWindowImpl {
   }
   async prevPage() {
     this._whiteboard.indexedNavigation.prevPage();
+    return _type.FcrReturnCode.SUCCESS;
   }
   async nextPage() {
     this._whiteboard.indexedNavigation.nextPage();
+    return _type.FcrReturnCode.SUCCESS;
   }
   async setToolType(type) {
     if (this._whiteboard) {
@@ -134,6 +143,7 @@ class FcrBoardMainWindowImpl {
     } else {
       throw new Error('Whiteboard is not initialized');
     }
+    return _type.FcrReturnCode.SUCCESS;
   }
   async setStrokeWidth(strokeWidth) {
     if (this._whiteboard) {
@@ -141,6 +151,7 @@ class FcrBoardMainWindowImpl {
     } else {
       throw new Error('Whiteboard is not initialized');
     }
+    return _type.FcrReturnCode.SUCCESS;
   }
   async setStrokeColor(color) {
     const c = typeof color === 'string' ? color : `rgb(${color.r},${color.g},${color.b})`;
@@ -149,6 +160,7 @@ class FcrBoardMainWindowImpl {
     } else {
       throw new Error('Whiteboard is not initialized');
     }
+    return _type.FcrReturnCode.SUCCESS;
   }
   async setTextColor(color) {
     const c = typeof color === 'string' ? color : `rgb(${color.r},${color.g},${color.b})`;
@@ -157,6 +169,7 @@ class FcrBoardMainWindowImpl {
     } else {
       throw new Error('Whiteboard is not initialized');
     }
+    return _type.FcrReturnCode.SUCCESS;
   }
   async setTextSize(textSize) {
     if (this._whiteboard) {
@@ -164,6 +177,7 @@ class FcrBoardMainWindowImpl {
     } else {
       throw new Error('Whiteboard is not initialized');
     }
+    return _type.FcrReturnCode.SUCCESS;
   }
   async insertImage(resourceUrl, x, y, width, height) {}
   getContentView() {
@@ -173,10 +187,12 @@ class FcrBoardMainWindowImpl {
   async setBoardTransparent(isTransparent) {}
   updateWindowSize(size) {
     size && this._whiteboard.updateViewport(size.width, size.height);
+    return _type.FcrReturnCode.SUCCESS;
   }
   setAutoCancelDraw(enable) {
     this._isAutoCancelEnabled = enable;
     this._enableAutoCancel(enable);
+    return _type.FcrReturnCode.SUCCESS;
   }
   getWritable() {
     return this._whiteboard.permissions.getPermissionFlags().some(flag => {
@@ -227,6 +243,7 @@ class FcrBoardMainWindowImpl {
     }
     this._boardView.setAttribute('data-app-id', appId);
     this._boardView.appendChild(app.view);
+    return _type.FcrReturnCode.SUCCESS;
   }
   _handleApplicationTerminal(appId, app) {
     try {
@@ -239,6 +256,7 @@ class FcrBoardMainWindowImpl {
     } catch (e) {
       this.logger.error(`failed to handle terminal: ${appId}`, e);
     }
+    return _type.FcrReturnCode.SUCCESS;
   }
   _setBoardViewStyle(view) {
     view.style.height = `100%`;
@@ -250,9 +268,10 @@ class FcrBoardMainWindowImpl {
     this._whiteboard.__setMainCanvasVisible(!enable);
     // @ts-ignore
     this._whiteboard.__delayTranslateOut = enable ? 4000 : -1;
+    return _type.FcrReturnCode.SUCCESS;
   }
   _addLogObserver() {
-    this.addObserver((0, _logger.generateLogObserver)(this.logger, ['onWritable', 'onPageInfoUpdated', 'onUndoStateUpdated', 'onRedoStateUpdated']));
+    this.addObserver((0, _logger.generateLogObserver)(this.logger, [['onWritable', ['isWritable']], ['onPageInfoUpdated', ['info']], ['onUndoStateUpdated', ['enable']], ['onRedoStateUpdated', ['enable']]]));
   }
 }
 exports.FcrBoardMainWindowImpl = FcrBoardMainWindowImpl;

package/lib/room-control/whiteboard-control-v2/type.d.ts

@@ -10,7 +10,7 @@ export interface FcrBaseWhiteboardControl<T extends FcrBaseWhiteboardObserver> {
     /**
      * Closes the whiteboard and releases the main window.
      */
-    close(): Promise<void>;
+    close(): Promise<number>;
     /**
      * Gets the connection state of the whiteboard.
      */
@@ -23,7 +23,7 @@ export interface FcrBaseWhiteboardControl<T extends FcrBaseWhiteboardObserver> {
      * Sets whether the current user has operation privilege.
      * @param hasOperationPrivilege
      */
-    setOperationPrivilege(hasOperationPrivilege: boolean): void;
+    setOperationPrivilege(hasOperationPrivilege: boolean): number;
     /**
      * Adds an observer to the whiteboard.
      * @param observer
@@ -56,61 +56,61 @@ export interface FcrBoardMainWindow {
     /**
      * Adds a page.
      */
-    addPage(): Promise<void>;
+    addPage(): Promise<number>;
     /**
      * Removes a page.
      */
-    removePage(): Promise<void>;
+    removePage(): Promise<number>;
     /**
      * Navigates to the previous page.
      */
-    prevPage(): Promise<void>;
+    prevPage(): Promise<number>;
     /**
      * Navigate to the next page.
      */
-    nextPage(): Promise<void>;
+    nextPage(): Promise<number>;
     /**
      * Undoes the operation.
      */
-    undo(): Promise<void>;
+    undo(): Promise<number>;
     /**
      * Redoes the operation.
      */
-    redo(): Promise<void>;
+    redo(): Promise<number>;
     /**
      * Cleans the whiteboard.
      */
-    clean(): Promise<void>;
+    clean(): Promise<number>;
     /**
      * Sets the tool type.
      * @param type
      */
-    setToolType(type: FcrBoardToolType): Promise<void>;
+    setToolType(type: FcrBoardToolType): Promise<number>;
     /**
      * Sets the stroke width.
      * @param strokeWidth
      */
-    setStrokeWidth(strokeWidth: number): Promise<void>;
+    setStrokeWidth(strokeWidth: number): Promise<number>;
     /**
      * Sets the stroke color.
      * @param color
      */
-    setStrokeColor(color: FcrColor): Promise<void>;
+    setStrokeColor(color: FcrColor): Promise<number>;
     /**
      * Sets the text color.
      * @param color
      */
-    setTextColor(color: FcrColor): Promise<void>;
+    setTextColor(color: FcrColor): Promise<number>;
     /**
      * Sets the text size.
      * @param textSize
      */
-    setTextSize(textSize: number): Promise<void>;
+    setTextSize(textSize: number): Promise<number>;
     /**
      * Sets the background color of the whiteboard.
      * @param color
      */
-    setBackgroundColor(color: string): Promise<void>;
+    setBackgroundColor(color: string): Promise<number>;
     /**
      * Sets the board background to transparent.
      */
@@ -137,12 +137,12 @@ export interface FcrBoardMainWindow {
      * Update the board canvas size.
      * @param ratio
      */
-    updateWindowSize(size: FcrSize): void;
+    updateWindowSize(size: FcrSize): number;
     /**
      * Sets auto cancel draw
      * @param enable
      */
-    setAutoCancelDraw(enable: boolean): void;
+    setAutoCancelDraw(enable: boolean): number;
     /**
      * Checks if the current user has write permission.
      */

package/lib/room-control/whiteboard-control-v2/whiteboard-control/control.d.ts

@@ -1,12 +1,13 @@
-import { FcrObjectForgeInitConfig } from '../type';
-import { AgoraRteScene } from '../../../imports';
+import { WhiteboardOption } from '@netless/forge-whiteboard';
 import type { RTMClient } from 'agora-rtm';
+import { AgoraRteScene } from '../../../imports';
 import { FcrCoreServiceApi } from '../../../service/api';
+import { FcrReturnCode } from '../../../type';
 import { FcrSharedCache } from '../../shared-cache';
-import { FcrBoardConfig, FcrStandaloneWhiteboardControl, FcrWhiteboardControl, FcrWhiteboardObserver } from './type';
-import { FcrBaseWhiteboardControlImpl } from '../base';
 import { FcrBoardActiveInfo } from '../../whiteboard-control/type';
-import { WhiteboardOption } from '@netless/forge-whiteboard';
+import { FcrBaseWhiteboardControlImpl } from '../base';
+import { FcrBoardMainWindow, FcrObjectForgeInitConfig } from '../type';
+import { FcrBoardConfig, FcrStandaloneWhiteboardControl, FcrWhiteboardControl, FcrWhiteboardObserver } from './type';
 export declare class FcrWhiteboardControlImpl extends FcrBaseWhiteboardControlImpl<FcrWhiteboardObserver> implements FcrWhiteboardControl {
     private _scene;
     private _api;
@@ -15,20 +16,25 @@ export declare class FcrWhiteboardControlImpl extends FcrBaseWhiteboardControlIm
     private _backgroundColor;
     private _isActive;
     private _ownerId;
+    private _preloadLock;
     private _notifyObservers;
     constructor(rtmClient: RTMClient, config: FcrBoardConfig, hasOperationPrivilege: boolean, sharedCache: FcrSharedCache, forgeInitConfigFetcher: () => Promise<FcrObjectForgeInitConfig>, _scene: AgoraRteScene, _api: FcrCoreServiceApi);
+    open(): Promise<FcrBoardMainWindow>;
+    close(): Promise<number>;
     active(): Promise<void>;
     inactive(): Promise<void>;
     getBoardActiveInfo(): FcrBoardActiveInfo;
-    setBackgroundColor(backgroundColor: string): Promise<void>;
+    setBackgroundColor(backgroundColor: string): Promise<FcrReturnCode>;
     getBackgroundColor(): string;
     getActivity(): boolean;
     getOwnerId(): string | null;
+    protected getApplicationId(): string;
     private _onScenePropertiesUpdated;
     protected getWhiteboardOption(): WhiteboardOption;
     protected addLogObserver(): void;
 }
 export declare class FcrStandaloneWhiteboardControlImpl extends FcrBaseWhiteboardControlImpl<FcrWhiteboardObserver> implements FcrStandaloneWhiteboardControl {
+    open(): Promise<FcrBoardMainWindow>;
     protected getApplicationId(): string;
     protected getWhiteboardOption(): WhiteboardOption;
 }

package/lib/room-control/whiteboard-control-v2/whiteboard-control/control.js

@@ -23,19 +23,20 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.FcrWhiteboardControlImpl = exports.FcrStandaloneWhiteboardControlImpl = void 0;
 var _imports = require("../../../imports");
-var _user = require("../../../utilities/user");
-var _error = require("../../../utilities/error");
 var _schema = require("../../../schema");
+var _type = require("../../../type");
+var _error = require("../../../utilities/error");
+var _logger = require("../../../utilities/logger");
 var _packageInfo = require("../../../utilities/package-info");
+var _user = require("../../../utilities/user");
 var _validateParams = _interopRequireDefault(require("../../../utilities/validate-params"));
+var _type2 = require("../../sharing-control/type");
+var _type3 = require("../../whiteboard-control/type");
 var _base = require("../base");
 var _constant = require("../constant");
-var _type = require("../../whiteboard-control/type");
-var _type2 = require("../../sharing-control/type");
-var _logger = require("../../../utilities/logger");
 var _utils = require("../utils");
-var _ref;
-let _initProto, _setBackgroundColorDecs;
+var _ref, _ref2;
+let _initProto, _setBackgroundColorDecs, _initProto2;
 function _applyDecs(e, t, r, n, o, a) { function i(e, t, r) { return function (n, o) { return r && r(n), e[t].call(n, o); }; } function c(e, t) { for (var r = 0; r < e.length; r++) e[r].call(t); return t; } function s(e, t, r, n) { if ("function" != typeof e && (n || void 0 !== e)) throw new TypeError(t + " must " + (r || "be") + " a function" + (n ? "" : " or undefined")); return e; } function applyDec(e, t, r, n, o, a, c, u, l, f, p, d, h) { function m(e) { if (!h(e)) throw new TypeError("Attempted to access private element on non-instance"); } var y, v = t[0], g = t[3], b = !u; if (!b) { r || Array.isArray(v) || (v = [v]); var w = {}, S = [], A = 3 === o ? "get" : 4 === o || d ? "set" : "value"; f ? (p || d ? w = { get: _setFunctionName(function () { return g(this); }, n, "get"), set: function (e) { t[4](this, e); } } : w[A] = g, p || _setFunctionName(w[A], n, 2 === o ? "" : A)) : p || (w = Object.getOwnPropertyDescriptor(e, n)); } for (var P = e, j = v.length - 1; j >= 0; j -= r ? 2 : 1) { var D = v[j], E = r ? v[j - 1] : void 0, I = {}, O = { kind: ["field", "accessor", "method", "getter", "setter", "class"][o], name: n, metadata: a, addInitializer: function (e, t) { if (e.v) throw Error("attempted to call addInitializer after decoration was finished"); s(t, "An initializer", "be", !0), c.push(t); }.bind(null, I) }; try { if (b) (y = s(D.call(E, P, O), "class decorators", "return")) && (P = y);else { var k, F; O.static = l, O.private = f, f ? 2 === o ? k = function (e) { return m(e), w.value; } : (o < 4 && (k = i(w, "get", m)), 3 !== o && (F = i(w, "set", m))) : (k = function (e) { return e[n]; }, (o < 2 || 4 === o) && (F = function (e, t) { e[n] = t; })); var N = O.access = { has: f ? h.bind() : function (e) { return n in e; } }; if (k && (N.get = k), F && (N.set = F), P = D.call(E, d ? { get: w.get, set: w.set } : w[A], O), d) { if ("object" == typeof P && P) (y = s(P.get, "accessor.get")) && (w.get = y), (y = s(P.set, "accessor.set")) && (w.set = y), (y = s(P.init, "accessor.init")) && S.push(y);else if (void 0 !== P) throw new TypeError("accessor decorators must return an object with get, set, or init properties or void 0"); } else s(P, (p ? "field" : "method") + " decorators", "return") && (p ? S.push(P) : w[A] = P); } } finally { I.v = !0; } } return (p || d) && u.push(function (e, t) { for (var r = S.length - 1; r >= 0; r--) t = S[r].call(e, t); return t; }), p || b || (f ? d ? u.push(i(w, "get"), i(w, "set")) : u.push(2 === o ? w[A] : i.call.bind(w[A])) : Object.defineProperty(e, n, w)), P; } function u(e, t) { return Object.defineProperty(e, Symbol.metadata || Symbol.for("Symbol.metadata"), { configurable: !0, enumerable: !0, value: t }); } if (arguments.length >= 6) var l = a[Symbol.metadata || Symbol.for("Symbol.metadata")]; var f = Object.create(null == l ? null : l), p = function (e, t, r, n) { var o, a, i = [], s = function (t) { return _checkInRHS(t) === e; }, u = new Map(); function l(e) { e && i.push(c.bind(null, e)); } for (var f = 0; f < t.length; f++) { var p = t[f]; if (Array.isArray(p)) { var d = p[1], h = p[2], m = p.length > 3, y = 16 & d, v = !!(8 & d), g = 0 == (d &= 7), b = h + "/" + v; if (!g && !m) { var w = u.get(b); if (!0 === w || 3 === w && 4 !== d || 4 === w && 3 !== d) throw Error("Attempted to decorate a public method/accessor that has the same name as a previously decorated public method/accessor. This is not currently supported by the decorators plugin. Property name was: " + h); u.set(b, !(d > 2) || d); } applyDec(v ? e : e.prototype, p, y, m ? "#" + h : _toPropertyKey(h), d, n, v ? a = a || [] : o = o || [], i, v, m, g, 1 === d, v && m ? s : r); } } return l(o), l(a), i; }(e, t, o, f); return r.length || u(e, f), { e: p, get c() { var t = []; return r.length && [u(applyDec(e, [r], n, e.name, 5, f, t), f), c.bind(null, t, e)]; } }; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
@@ -43,14 +44,15 @@ function _setFunctionName(e, t, n) { "symbol" == typeof t && (t = (t = t.descrip
 function _checkInRHS(e) { if (Object(e) !== e) throw TypeError("right-hand side of 'in' should be an object, got " + (null !== e ? typeof e : "null")); return e; }
 class FcrWhiteboardControlImpl extends (_ref = _base.FcrBaseWhiteboardControlImpl) {
   static {
-    [_initProto] = _applyDecs(this, [[_imports.trace, 2, "active"], [_imports.trace, 2, "inactive"], [_setBackgroundColorDecs, 2, "setBackgroundColor"], [_imports.trace, 2, "getBackgroundColor"], [_imports.trace, 2, "getActivity"], [_imports.trace, 2, "getOwnerId"], [_imports.bound, 2, "_onScenePropertiesUpdated"]], [], 0, void 0, _ref).e;
+    [_initProto] = _applyDecs(this, [[_imports.trace, 2, "open"], [_imports.trace, 2, "close"], [_imports.trace, 2, "active"], [_imports.trace, 2, "inactive"], [_setBackgroundColorDecs, 2, "setBackgroundColor"], [_imports.trace, 2, "getBackgroundColor"], [_imports.trace, 2, "getActivity"], [_imports.trace, 2, "getOwnerId"], [_imports.bound, 2, "_onScenePropertiesUpdated"]], [], 0, void 0, _ref).e;
   }
-  [(_setBackgroundColorDecs = [_imports.trace, (0, _validateParams.default)(_schema.stringSchema)], "logger")] = (_initProto(this), (0, _logger.createLogger)({
+  [(_setBackgroundColorDecs = [(0, _imports.trace)(['backgroundColor']), (0, _validateParams.default)(_schema.stringSchema)], "logger")] = (_initProto(this), (0, _logger.createLogger)({
     prefix: 'FcrWhiteboardControlImpl'
   }));
   _backgroundColor = '#ffffff';
   _isActive = false;
   _ownerId = null;
+  _preloadLock = false;
   _notifyObservers = {
     onScenePropertiesUpdated: this._onScenePropertiesUpdated
   };
@@ -72,18 +74,48 @@ class FcrWhiteboardControlImpl extends (_ref = _base.FcrBaseWhiteboardControlImp
     }
     this.logger.info(`initialized, hasOperationPrivilege: ${hasOperationPrivilege}`);
   }
+  async open() {
+    const boardActiveInfo = this.getBoardActiveInfo();
+    if (!boardActiveInfo.isActive) {
+      await (0, _error.handleRequestError)(() => this._api.toggleWhiteboardPreloadState(this.config.roomId, _type2.FcrSharePermissionState.ON), _imports.ErrorModuleCode.FCR_ROOM_WHITEBOARD, 'lock failed when open whiteboard');
+
+      // 标记白板锁状态, 关闭白板时判断是否需要解锁
+      this._preloadLock = true;
+      try {
+        this._isActive = true;
+        return await super.internalOpen(true);
+      } catch (error) {
+        // 开启失败, 释放锁
+        this._preloadLock = false;
+        this._isActive = false;
+        await (0, _error.handleRequestError)(() => this._api.toggleWhiteboardPreloadState(this.config.roomId, _type2.FcrSharePermissionState.OFF), _imports.ErrorModuleCode.FCR_ROOM_WHITEBOARD, 'unlock failed when open whiteboard');
+        throw error;
+      }
+    } else {
+      return await super.internalOpen(false);
+    }
+  }
+  async close() {
+    const result = await super.close();
+    if (this._preloadLock) {
+      // 释放白板锁
+      await (0, _error.handleRequestError)(() => this._api.toggleWhiteboardPreloadState(this.config.roomId, _type2.FcrSharePermissionState.OFF), _imports.ErrorModuleCode.FCR_ROOM_WHITEBOARD, 'unlock failed when close whiteboard');
+      this._preloadLock = false;
+    }
+    return result;
+  }
   async active() {
-    return (0, _error.handleRequestError)(() => this._api.toggleWhiteboardActivityState(this.config.roomId, _type2.FcrSharePermissionState.ON), _error.FcrErrorModuleCode.ROOM_WHITEBOARD, 'active failed');
+    return (0, _error.handleRequestError)(() => this._api.toggleWhiteboardActivityState(this.config.roomId, _type2.FcrSharePermissionState.ON), _imports.ErrorModuleCode.FCR_ROOM_WHITEBOARD, 'active failed');
   }
   async inactive() {
-    return (0, _error.handleRequestError)(() => this._api.toggleWhiteboardActivityState(this.config.roomId, _type2.FcrSharePermissionState.OFF), _error.FcrErrorModuleCode.ROOM_WHITEBOARD, 'inactive failed');
+    return (0, _error.handleRequestError)(() => this._api.toggleWhiteboardActivityState(this.config.roomId, _type2.FcrSharePermissionState.OFF), _imports.ErrorModuleCode.FCR_ROOM_WHITEBOARD, 'inactive failed');
   }
   getBoardActiveInfo() {
     const {
       state,
       ownerUserUuid: ownerUserId
     } = this._scene.getScenePropertiesByKeyPath('widgets.netlessBoard');
-    if (state === _type.FcrBoardPropertiesState.ACTIVE) {
+    if (state === _type3.FcrBoardPropertiesState.ACTIVE) {
       return {
         isActive: true,
         ownerUserId
@@ -104,6 +136,7 @@ class FcrWhiteboardControlImpl extends (_ref = _base.FcrBaseWhiteboardControlImp
     if (this.boardView) {
       this.boardView.setBackgroundColor(backgroundColor);
     }
+    return _type.FcrReturnCode.SUCCESS;
   }
   getBackgroundColor() {
     return this._backgroundColor;
@@ -114,26 +147,29 @@ class FcrWhiteboardControlImpl extends (_ref = _base.FcrBaseWhiteboardControlImp
   getOwnerId() {
     return this._ownerId;
   }
+  getApplicationId() {
+    return _constant.WHITEBOARD_APP_ID;
+  }
   _onScenePropertiesUpdated(sceneId, event) {
     const operatorUser = (0, _user.convertRteUserToFcrUser)(event.operatorUser, this._roomCache);
     const getByKeyPath = value => this._scene.getScenePropertiesByKeyPath(value);
     if (event.cause && event.cause.cmd === 10) {
-      const state = getByKeyPath('widgets.netlessBoard.state') ?? _type.FcrBoardPropertiesState.INACTIVE;
+      const state = getByKeyPath('widgets.netlessBoard.state') ?? _type3.FcrBoardPropertiesState.INACTIVE;
       const backgroundColor = getByKeyPath('widgets.netlessBoard.extra.backgroundColor');
       const widgetCauseReason = (0, _imports.get)(event.cause.data, 'widgetCause.data.reason');
       const widgetCauseCmd = (0, _imports.get)(event.cause.data, 'widgetCause.cmd');
-      if (state === _type.FcrBoardPropertiesState.ACTIVE) {
+      if (state === _type3.FcrBoardPropertiesState.ACTIVE) {
         const ownerUserId = getByKeyPath('widgets.netlessBoard.ownerUserUuid');
         this._ownerId = ownerUserId;
         this._isActive = true;
         this.observable.notifyObservers('onActive', ownerUserId, operatorUser);
       }
-      if (state === _type.FcrBoardPropertiesState.INACTIVE) {
+      if (state === _type3.FcrBoardPropertiesState.INACTIVE) {
         this._ownerId = null;
         this._isActive = false;
         this.observable.notifyObservers('onInactive', widgetCauseReason, operatorUser);
       }
-      if (widgetCauseCmd === _type.FcrBoardPropertiesState.BACKGROUND_COLOR_UPDATED) {
+      if (widgetCauseCmd === _type3.FcrBoardPropertiesState.BACKGROUND_COLOR_UPDATED) {
         this._backgroundColor = backgroundColor;
         this.observable.notifyObservers('onBackgroundColorUpdated', backgroundColor, operatorUser);
       }
@@ -147,11 +183,21 @@ class FcrWhiteboardControlImpl extends (_ref = _base.FcrBaseWhiteboardControlImp
     };
   }
   addLogObserver() {
-    this.addObserver((0, _logger.generateLogObserver)(this.logger, ['onConnectionStateUpdated', 'onActive', 'onInactive', 'onBackgroundColorUpdated']));
+    this.addObserver((0, _logger.generateLogObserver)(this.logger, [['onConnectionStateUpdated', ['state']], ['onActive', ['ownerId', 'operatorUser']], ['onInactive', ['reason', 'operatorUser']], ['onBackgroundColorUpdated', ['color', 'operatorUser']]]));
   }
 }
 exports.FcrWhiteboardControlImpl = FcrWhiteboardControlImpl;
-class FcrStandaloneWhiteboardControlImpl extends _base.FcrBaseWhiteboardControlImpl {
+class FcrStandaloneWhiteboardControlImpl extends (_ref2 = _base.FcrBaseWhiteboardControlImpl) {
+  static {
+    [_initProto2] = _applyDecs(this, [[_imports.trace, 2, "open"]], [], 0, void 0, _ref2).e;
+  }
+  constructor(...args) {
+    super(...args);
+    _initProto2(this);
+  }
+  async open() {
+    return await super.internalOpen(false);
+  }
   getApplicationId() {
     return _constant.WHITEBOARD_APP_ID;
   }

package/lib/room-control/whiteboard-control-v2/whiteboard-control/factory.d.ts

@@ -1,8 +1,8 @@
+import { AgoraRteScene } from 'agora-rte-sdk';
+import type { RTMClient } from 'agora-rtm';
 import { FcrCoreServiceApi } from '../../../service/api';
 import { FcrSharedCache } from '../../shared-cache';
 import { FcrBoardConfig, FcrStandaloneWhiteboardControl, FcrWhiteboardControl, FcrWhiteboardControlFactory } from './type';
-import type { RTMClient } from 'agora-rtm';
-import { AgoraRteScene } from 'agora-rte-sdk';
 export declare class FcrWhiteboardControlFactoryImpl implements FcrWhiteboardControlFactory {
     protected logger: import("agora-foundation/lib/logger").Logger;
     createForSubProcess(rtmClient: RTMClient, hasOperationPrivilege: boolean, boardConfig: FcrBoardConfig): FcrStandaloneWhiteboardControl;

package/lib/room-control/whiteboard-control-v2/whiteboard-control/factory.js

@@ -21,13 +21,13 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.FcrWhiteboardControlFactoryImpl = void 0;
-var _logger = require("../../../utilities/logger");
-var _error = require("../../../utilities/error");
 var _log = require("agora-foundation/lib/decorator/log");
-var _base = require("../base");
-var _control = require("./control");
+var _errorCode = require("agora-foundation/lib/utilities/error/error-code");
+var _error = require("../../../utilities/error");
+var _logger = require("../../../utilities/logger");
 var _sharedStorage = require("../../../utilities/shared-storage");
-let _initProto;
+var _control = require("./control");
+let _initProto, _createForSubProcessDecs, _createForMainProcessDecs;
 function _applyDecs(e, t, r, n, o, a) { function i(e, t, r) { return function (n, o) { return r && r(n), e[t].call(n, o); }; } function c(e, t) { for (var r = 0; r < e.length; r++) e[r].call(t); return t; } function s(e, t, r, n) { if ("function" != typeof e && (n || void 0 !== e)) throw new TypeError(t + " must " + (r || "be") + " a function" + (n ? "" : " or undefined")); return e; } function applyDec(e, t, r, n, o, a, c, u, l, f, p, d, h) { function m(e) { if (!h(e)) throw new TypeError("Attempted to access private element on non-instance"); } var y, v = t[0], g = t[3], b = !u; if (!b) { r || Array.isArray(v) || (v = [v]); var w = {}, S = [], A = 3 === o ? "get" : 4 === o || d ? "set" : "value"; f ? (p || d ? w = { get: _setFunctionName(function () { return g(this); }, n, "get"), set: function (e) { t[4](this, e); } } : w[A] = g, p || _setFunctionName(w[A], n, 2 === o ? "" : A)) : p || (w = Object.getOwnPropertyDescriptor(e, n)); } for (var P = e, j = v.length - 1; j >= 0; j -= r ? 2 : 1) { var D = v[j], E = r ? v[j - 1] : void 0, I = {}, O = { kind: ["field", "accessor", "method", "getter", "setter", "class"][o], name: n, metadata: a, addInitializer: function (e, t) { if (e.v) throw Error("attempted to call addInitializer after decoration was finished"); s(t, "An initializer", "be", !0), c.push(t); }.bind(null, I) }; try { if (b) (y = s(D.call(E, P, O), "class decorators", "return")) && (P = y);else { var k, F; O.static = l, O.private = f, f ? 2 === o ? k = function (e) { return m(e), w.value; } : (o < 4 && (k = i(w, "get", m)), 3 !== o && (F = i(w, "set", m))) : (k = function (e) { return e[n]; }, (o < 2 || 4 === o) && (F = function (e, t) { e[n] = t; })); var N = O.access = { has: f ? h.bind() : function (e) { return n in e; } }; if (k && (N.get = k), F && (N.set = F), P = D.call(E, d ? { get: w.get, set: w.set } : w[A], O), d) { if ("object" == typeof P && P) (y = s(P.get, "accessor.get")) && (w.get = y), (y = s(P.set, "accessor.set")) && (w.set = y), (y = s(P.init, "accessor.init")) && S.push(y);else if (void 0 !== P) throw new TypeError("accessor decorators must return an object with get, set, or init properties or void 0"); } else s(P, (p ? "field" : "method") + " decorators", "return") && (p ? S.push(P) : w[A] = P); } } finally { I.v = !0; } } return (p || d) && u.push(function (e, t) { for (var r = S.length - 1; r >= 0; r--) t = S[r].call(e, t); return t; }), p || b || (f ? d ? u.push(i(w, "get"), i(w, "set")) : u.push(2 === o ? w[A] : i.call.bind(w[A])) : Object.defineProperty(e, n, w)), P; } function u(e, t) { return Object.defineProperty(e, Symbol.metadata || Symbol.for("Symbol.metadata"), { configurable: !0, enumerable: !0, value: t }); } if (arguments.length >= 6) var l = a[Symbol.metadata || Symbol.for("Symbol.metadata")]; var f = Object.create(null == l ? null : l), p = function (e, t, r, n) { var o, a, i = [], s = function (t) { return _checkInRHS(t) === e; }, u = new Map(); function l(e) { e && i.push(c.bind(null, e)); } for (var f = 0; f < t.length; f++) { var p = t[f]; if (Array.isArray(p)) { var d = p[1], h = p[2], m = p.length > 3, y = 16 & d, v = !!(8 & d), g = 0 == (d &= 7), b = h + "/" + v; if (!g && !m) { var w = u.get(b); if (!0 === w || 3 === w && 4 !== d || 4 === w && 3 !== d) throw Error("Attempted to decorate a public method/accessor that has the same name as a previously decorated public method/accessor. This is not currently supported by the decorators plugin. Property name was: " + h); u.set(b, !(d > 2) || d); } applyDec(v ? e : e.prototype, p, y, m ? "#" + h : _toPropertyKey(h), d, n, v ? a = a || [] : o = o || [], i, v, m, g, 1 === d, v && m ? s : r); } } return l(o), l(a), i; }(e, t, o, f); return r.length || u(e, f), { e: p, get c() { var t = []; return r.length && [u(applyDec(e, [r], n, e.name, 5, f, t), f), c.bind(null, t, e)]; } }; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
@@ -35,16 +35,16 @@ function _setFunctionName(e, t, n) { "symbol" == typeof t && (t = (t = t.descrip
 function _checkInRHS(e) { if (Object(e) !== e) throw TypeError("right-hand side of 'in' should be an object, got " + (null !== e ? typeof e : "null")); return e; }
 class FcrWhiteboardControlFactoryImpl {
   static {
-    [_initProto] = _applyDecs(this, [[_log.trace, 2, "createForSubProcess"], [_log.trace, 2, "createForMainProcess"]], []).e;
+    [_initProto] = _applyDecs(this, [[_createForSubProcessDecs, 2, "createForSubProcess"], [_createForMainProcessDecs, 2, "createForMainProcess"]], []).e;
   }
-  logger = (_initProto(this), (0, _logger.createLogger)({
+  [(_createForSubProcessDecs = (0, _log.trace)(['rtmClient', 'hasOperationPrivilege', 'boardConfig']), _createForMainProcessDecs = (0, _log.trace)(['rtmClient', 'hasOperationPrivilege', 'boardConfig', 'scene', 'api', 'sharedCache']), "logger")] = (_initProto(this), (0, _logger.createLogger)({
     prefix: 'FcrWhiteboardControlFactory'
   }));
   createForSubProcess(rtmClient, hasOperationPrivilege, boardConfig) {
-    return new _base.FcrBaseWhiteboardControlImpl(rtmClient, boardConfig, hasOperationPrivilege, () => {
+    return new _control.FcrStandaloneWhiteboardControlImpl(rtmClient, boardConfig, hasOperationPrivilege, () => {
       const forgeInitConfig = (0, _sharedStorage.getWhiteboardOptions)();
       if (!forgeInitConfig) {
-        throw (0, _error.generateFcrCoreClientError)(_error.FcrErrorModuleCode.ROOM_WHITEBOARD, _error.FcrErrorCode.UNDEFINED_ERROR, `whiteboard init config is not exist`, new Error(`whiteboard init config is not exist`));
+        throw (0, _error.generateFcrCoreClientError)(_errorCode.ErrorModuleCode.FCR_ROOM_WHITEBOARD, _errorCode.DetailErrorCode.UNDEFINED_ERROR, `whiteboard init config is not exist`, new Error(`whiteboard init config is not exist`));
       }
       return Promise.resolve(forgeInitConfig);
     });
@@ -57,7 +57,7 @@ class FcrWhiteboardControlFactoryImpl {
       return await (0, _error.handleRequestError)(() => api.getWhiteboardToken({
         roomId,
         userId
-      }), _error.FcrErrorModuleCode.ROOM_WHITEBOARD, 'get whiteboard token failed');
+      }), _errorCode.ErrorModuleCode.FCR_ROOM_WHITEBOARD, 'get whiteboard token failed');
     };
     return async () => {
       const response = await getObjectInitConfig(roomId, userId);

package/lib/room-control/whiteboard-control-v2/whiteboard-control/type.d.ts

@@ -13,7 +13,7 @@ export interface FcrWhiteboardControl extends FcrBaseWhiteboardControl<FcrWhiteb
     getActivity(): boolean;
     getOwnerId(): string | null;
     getBackgroundColor(): string;
-    setBackgroundColor(color: string): Promise<void>;
+    setBackgroundColor(color: string): Promise<number>;
 }
 export interface FcrWhiteboardObserver extends FcrBaseWhiteboardObserver {
     /**