@bitrix24/b24jssdk 0.1.4 → 0.1.5

package/dist/commonjs/index.d.cts

@@ -579,6 +579,12 @@ type TypeHttp = {
     getRestrictionManagerParams(): TypeRestrictionManagerParams;
     setLogTag(logTag?: string): void;
     clearLogTag(): void;
+    /**
+     * On|Off warning about client-side query execution
+     * @param {boolean} value
+     * @param {string} message
+     */
+    setClientSideWarning(value: boolean, message: string): void;
 };
 interface IRequestIdGenerator {
     getRequestId(): string;
@@ -1613,6 +1619,10 @@ declare class B24Hook extends AbstractB24 implements TypeB24 {
     constructor(b24HookParams: B24HookParams);
     setLogger(logger: LoggerBrowser): void;
     get auth(): AuthActions;
+    /**
+     * Disables warning about client-side query execution
+     */
+    offClientSideWarning(): void;
     /**
      * Get the account address BX24 ( https://name.bitrix24.com )
      */

package/dist/commonjs/index.d.mts

@@ -579,6 +579,12 @@ type TypeHttp = {
     getRestrictionManagerParams(): TypeRestrictionManagerParams;
     setLogTag(logTag?: string): void;
     clearLogTag(): void;
+    /**
+     * On|Off warning about client-side query execution
+     * @param {boolean} value
+     * @param {string} message
+     */
+    setClientSideWarning(value: boolean, message: string): void;
 };
 interface IRequestIdGenerator {
     getRequestId(): string;
@@ -1613,6 +1619,10 @@ declare class B24Hook extends AbstractB24 implements TypeB24 {
     constructor(b24HookParams: B24HookParams);
     setLogger(logger: LoggerBrowser): void;
     get auth(): AuthActions;
+    /**
+     * Disables warning about client-side query execution
+     */
+    offClientSideWarning(): void;
     /**
      * Get the account address BX24 ( https://name.bitrix24.com )
      */

package/dist/commonjs/index.d.ts

@@ -579,6 +579,12 @@ type TypeHttp = {
     getRestrictionManagerParams(): TypeRestrictionManagerParams;
     setLogTag(logTag?: string): void;
     clearLogTag(): void;
+    /**
+     * On|Off warning about client-side query execution
+     * @param {boolean} value
+     * @param {string} message
+     */
+    setClientSideWarning(value: boolean, message: string): void;
 };
 interface IRequestIdGenerator {
     getRequestId(): string;
@@ -1613,6 +1619,10 @@ declare class B24Hook extends AbstractB24 implements TypeB24 {
     constructor(b24HookParams: B24HookParams);
     setLogger(logger: LoggerBrowser): void;
     get auth(): AuthActions;
+    /**
+     * Disables warning about client-side query execution
+     */
+    offClientSideWarning(): void;
     /**
      * Get the account address BX24 ( https://name.bitrix24.com )
      */

package/dist/esm/index.d.mts

@@ -579,6 +579,12 @@ type TypeHttp = {
     getRestrictionManagerParams(): TypeRestrictionManagerParams;
     setLogTag(logTag?: string): void;
     clearLogTag(): void;
+    /**
+     * On|Off warning about client-side query execution
+     * @param {boolean} value
+     * @param {string} message
+     */
+    setClientSideWarning(value: boolean, message: string): void;
 };
 interface IRequestIdGenerator {
     getRequestId(): string;
@@ -1613,6 +1619,10 @@ declare class B24Hook extends AbstractB24 implements TypeB24 {
     constructor(b24HookParams: B24HookParams);
     setLogger(logger: LoggerBrowser): void;
     get auth(): AuthActions;
+    /**
+     * Disables warning about client-side query execution
+     */
+    offClientSideWarning(): void;
     /**
      * Get the account address BX24 ( https://name.bitrix24.com )
      */

package/dist/esm/index.d.ts

@@ -579,6 +579,12 @@ type TypeHttp = {
     getRestrictionManagerParams(): TypeRestrictionManagerParams;
     setLogTag(logTag?: string): void;
     clearLogTag(): void;
+    /**
+     * On|Off warning about client-side query execution
+     * @param {boolean} value
+     * @param {string} message
+     */
+    setClientSideWarning(value: boolean, message: string): void;
 };
 interface IRequestIdGenerator {
     getRequestId(): string;
@@ -1613,6 +1619,10 @@ declare class B24Hook extends AbstractB24 implements TypeB24 {
     constructor(b24HookParams: B24HookParams);
     setLogger(logger: LoggerBrowser): void;
     get auth(): AuthActions;
+    /**
+     * Disables warning about client-side query execution
+     */
+    offClientSideWarning(): void;
     /**
      * Get the account address BX24 ( https://name.bitrix24.com )
      */

package/dist/esm/index.mjs

@@ -1,5 +1,5 @@
 /**
- * @version @bitrix24/b24jssdk v0.1.4
+ * @version @bitrix24/b24jssdk v0.1.5
  * @copyright (c) 2024 Bitrix24
  * @licence MIT
  * @links https://github.com/bitrix24/b24jssdk - GitHub
@@ -1324,7 +1324,10 @@ class Http {
   #restrictionManager;
   #requestIdGenerator;
   _logger = null;
+  _loggerSystem = null;
   #logTag = "";
+  #isClientSideWarning = false;
+  #clientSideWarningMessage = "";
   constructor(baseURL, authActions, options) {
     this.#clientAxios = axios.create({
       baseURL,
@@ -1334,6 +1337,7 @@ class Http {
     this.#restrictionManager = new RestrictionManager();
     this.#requestIdGenerator = new DefaultRequestIdGenerator();
   }
+  // region Logger ////
   setLogger(logger) {
     this._logger = logger;
     this.#restrictionManager.setLogger(this.getLogger());
@@ -1352,18 +1356,38 @@ class Http {
     }
     return this._logger;
   }
+  getSystemLogger() {
+    if (null === this._loggerSystem) {
+      this._loggerSystem = LoggerBrowser.build(`SystemLogger`);
+      this._loggerSystem.setConfig({
+        [LoggerType.desktop]: false,
+        [LoggerType.log]: false,
+        [LoggerType.info]: true,
+        [LoggerType.warn]: true,
+        [LoggerType.error]: true,
+        [LoggerType.trace]: false
+      });
+    }
+    return this._loggerSystem;
+  }
+  // endregion ////
+  // region RestrictionManager ////
   setRestrictionManagerParams(params) {
     this.#restrictionManager.params = params;
   }
   getRestrictionManagerParams() {
     return this.#restrictionManager.params;
   }
+  // endregion ////
+  // region LogTag ////
   setLogTag(logTag) {
     this.#logTag = logTag;
   }
   clearLogTag() {
     this.#logTag = "";
   }
+  // endregion ////
+  // region Actions Call ////
   async batch(calls, isHaltOnError = true) {
     const isArrayMode = Array.isArray(calls);
     const cmd = isArrayMode ? [] : {};
@@ -1505,6 +1529,9 @@ class Http {
       authData = await this.#authActions.refreshAuth();
     }
     await this.#restrictionManager.check();
+    if (this.#isClientSideWarning && !this.isServerSide() && Type.isStringFilled(this.#clientSideWarningMessage)) {
+      this.getSystemLogger().warn(this.#clientSideWarningMessage);
+    }
     return this.#clientAxios.post(
       this.#prepareMethod(method),
       this.#prepareParams(authData, params, start)
@@ -1588,6 +1615,8 @@ class Http {
       return Promise.resolve(result);
     });
   }
+  // endregion ////
+  // region Prepare ////
   /**
    * Processes function parameters and adds authorization
    *
@@ -1603,7 +1632,7 @@ class Http {
       result.logTag = this.#logTag;
     }
     result[this.#requestIdGenerator.getQueryStringParameterName()] = this.#requestIdGenerator.getRequestId();
-    result[this.#requestIdGenerator.getQueryStringSdkParameterName()] = "0.1.4";
+    result[this.#requestIdGenerator.getQueryStringSdkParameterName()] = "0.1.5";
     if (!!result.data && !!result.data.start) {
       delete result.data.start;
     }
@@ -1622,6 +1651,24 @@ class Http {
   #prepareMethod(method) {
     return `${encodeURIComponent(method)}.json`;
   }
+  /**
+   * @inheritDoc
+   */
+  setClientSideWarning(value, message) {
+    this.#isClientSideWarning = value;
+    this.#clientSideWarningMessage = message;
+  }
+  // endregion ////
+  // region Tools ////
+  /**
+   * Tests whether the code is executed on the client side
+   * @return {boolean}
+   * @protected
+   */
+  isServerSide() {
+    return Type.isUndefined(window);
+  }
+  // endregion ////
 }
 
 class AbstractB24 {
@@ -2676,6 +2723,10 @@ class B24Hook extends AbstractB24 {
       this.#authHookManager,
       this._getHttpOptions()
     );
+    this._http.setClientSideWarning(
+      true,
+      "It is not safe to use hook requests on the client side"
+    );
     this._isInit = true;
   }
   setLogger(logger) {
@@ -2686,6 +2737,12 @@ class B24Hook extends AbstractB24 {
     return this.#authHookManager;
   }
   // region Core ////
+  /**
+   * Disables warning about client-side query execution
+   */
+  offClientSideWarning() {
+    this.getHttpClient().setClientSideWarning(false, "");
+  }
   // endregion ////
   // region Get ////
   /**