@bitrix24/b24jssdk 0.1.0 → 0.1.1

package/dist/commonjs/index.d.cts

@@ -107,7 +107,7 @@ declare class TypeManager {
      */
     isString(value: any): boolean;
     /**
-     * Returns true if a value is not empty string
+     * Returns true if a value is not an empty string
      * @param value
      * @returns {boolean}
      */
@@ -121,7 +121,7 @@ declare class TypeManager {
      */
     isFunction(value: any): boolean;
     /**
-     * Checks that value is object
+     * Checks that value is an object
      * @param value
      * @return {boolean}
      */
@@ -171,7 +171,7 @@ declare class TypeManager {
      */
     isNil(value: any): boolean;
     /**
-     * Checks that value is array
+     * Checks that value is an array
      * @param value
      * @return {boolean}
      */
@@ -195,7 +195,7 @@ declare class TypeManager {
      */
     isDate(value: any): boolean;
     /**
-     * Checks that is DOM node
+     * Checks that is a DOM node
      * @param value
      * @return {boolean}
      */
@@ -207,7 +207,7 @@ declare class TypeManager {
      */
     isElementNode(value: any): boolean;
     /**
-     * Checks that value is text node
+     * Checks that value is a text node
      * @param value
      * @return {boolean}
      */
@@ -540,7 +540,7 @@ type Payload<P> = GetPayload<P> | ListPayload<P> | BatchPayload<P>;
 
 type AjaxQuery = {
     method: string;
-    params: {};
+    params: object;
     start: number;
 };
 type AjaxResultParams = {
@@ -910,7 +910,7 @@ declare const EnumAppStatus: {
     readonly Local: "L";
     readonly Subscription: "S";
 };
-declare const StatusDescriptions: Record<typeof EnumAppStatus[keyof typeof EnumAppStatus], string>;
+declare const StatusDescriptions: Record<(typeof EnumAppStatus)[keyof typeof EnumAppStatus], string>;
 type TypeEnumAppStatus = keyof typeof EnumAppStatus;
 /**
  * @link https://dev.1c-bitrix.ru/rest_help/general/app_info.php
@@ -1487,7 +1487,7 @@ declare class IbanSpecification {
     private _cachedRegex;
     constructor(countryCode: string, length: number, structure: string, example: string);
     /**
-     * Check if the passed iban is valid according to this specification.
+     * Check if the passed iban is valid, according to this specification.
      *
      * @param {String} iban the iban to validate
      * @returns {boolean} true if valid, false otherwise
@@ -1512,11 +1512,11 @@ declare class IbanSpecification {
     fromBBAN(bban: string): string;
     /**
      * Check of the passed BBAN is valid.
-     * This function only checks the format of the BBAN (length and matching the letetr/number specs) but does not
+     * This function only checks the format of the BBAN (length and compliance with alphanumeric specifications) but does not
      * verify the check digit.
      *
      * @param bban the BBAN to validate
-     * @returns {boolean} true if the passed bban is a valid BBAN according to this specification, false otherwise
+     * @returns {boolean} true if the passed bban is a valid BBAN, according to this specification, false otherwise
      */
     isValidBBAN(bban: string): boolean;
     /**
@@ -1525,9 +1525,11 @@ declare class IbanSpecification {
     private _regex;
     /**
      * Parse the BBAN structure used to configure each IBAN Specification and returns a matching regular expression.
-     * A structure is composed of blocks of 3 characters (one letter and 2 digits). Each block represents
-     * a logical group in the typical representation of the BBAN. For each group, the letter indicates which characters
-     * are allowed in this group and the following 2-digits number tells the length of the group.
+     * A structure is composed of blocks of three characters (one letter and two digits).
+     * Each block represents
+     * a logical group in the typical representation of the BBAN.
+     * For each group, the letter indicates which characters
+     * are allowed in this group, and the following 2-digits number tells the length of the group.
      *
      * @param {string} structure the structure to parse
      * @returns {RegExp}
@@ -1542,7 +1544,7 @@ declare class IbanSpecification {
      */
     private _iso13616Prepare;
     /**
-     * Calculates the MOD 97 10 of the passed IBAN as specified in ISO7064.
+     * Calculates MOD 97 10 of the passed IBAN as specified in ISO7064.
      *
      * @param iban
      * @returns {number}
@@ -1690,11 +1692,11 @@ declare class AppFrame {
      */
     getAppSid(): string;
     /**
-     * Get the account address BX24 ( https://name.bitrix24.com )
+     * Get the account address BX24 (https://name.bitrix24.com)
      */
     getTargetOrigin(): string;
     /**
-     * Get the account address BX24 with Path ( https://name.bitrix24.com/rest )
+     * Get the account address BX24 with Path (https://name.bitrix24.com/rest)
      */
     getTargetOriginWithPath(): string;
     /**
@@ -2339,7 +2341,7 @@ declare class OptionsManager extends AbstractHelper {
      */
     initData(data: any): Promise<void>;
     getJsonArray(key: string, defValue?: any[]): any[];
-    getJsonObject(key: string, defValue?: Object): Object;
+    getJsonObject(key: string, defValue?: object): object;
     getFloat(key: string, defValue?: number): number;
     getInteger(key: string, defValue?: number): number;
     getBoolYN(key: string, defValue?: boolean): boolean;
@@ -2387,7 +2389,7 @@ declare class B24HelperManager {
     get isInit(): boolean;
     get forB24Form(): TypeB24Form;
     /**
-     * Get the account address BX24 ( https://name.bitrix24.com )
+     * Get the account address BX24 (https://name.bitrix24.com)
      */
     get hostName(): string;
     get profileInfo(): ProfileManager;
@@ -2400,7 +2402,7 @@ declare class B24HelperManager {
     get isSelfHosted(): boolean;
     /**
      * Returns the increment step of fields of type ID
-     * @memo in cloud step = 2 in box step = 1
+     * @memo in a cloud step = 2 in box step = 1
      *
      * @returns {number}
      */
@@ -2468,7 +2470,6 @@ declare class PullClient implements ConnectorParent {
     private _jsonRpcAdapter;
     /**
      * @depricate
-     * @private
      */
     private _checkInterval;
     private _offlineTimeout;
@@ -2481,79 +2482,54 @@ declare class PullClient implements ConnectorParent {
     private _connectPromise;
     private _startingPromise;
     /**
-     * @done
      * @param params
      */
     constructor(params: TypePullClientParams);
     setLogger(logger: LoggerBrowser): void;
     getLogger(): LoggerBrowser;
     destroy(): void;
-    /**
-     * @done
-     * @private
-     */
     private init;
-    /**
-     * @done
-     */
     get connector(): null | TypeConnector;
-    /**
-     * @done
-     */
     get status(): PullStatus;
     /**
-     * @done
      * @param status
      */
     set status(status: PullStatus);
     get session(): TypePullClientSession;
     /**
-     * @done
      * Creates a subscription to incoming messages.
      *
      * @param {TypeSubscriptionOptions | TypeSubscriptionCommandHandler} params
-     * @returns {Function} - Unsubscribe callback function
+     * @returns { () => void } - Unsubscribe callback function
      */
-    subscribe(params: TypeSubscriptionOptions | TypeSubscriptionCommandHandler): Function;
+    subscribe(params: TypeSubscriptionOptions | TypeSubscriptionCommandHandler): () => void;
     /**
-     * @done
      * @param {TypeSubscriptionCommandHandler} handler
-     * @returns {Function} - Unsubscribe callback function
+     * @returns {() => void} - Unsubscribe callback function
      */
     private attachCommandHandler;
     /**
-     * @done
      * @param config
      */
-    start(config?: null | TypePullClientConfig & {
+    start(config?: null | (TypePullClientConfig & {
         skipReconnectToLastSession?: boolean;
-    }): Promise<boolean>;
+    })): Promise<boolean>;
     /**
-     * @done
      * @param disconnectCode
      * @param disconnectReason
      */
     restart(disconnectCode?: number | CloseReasons, disconnectReason?: string): void;
-    /**
-     * @done
-     */
     stop(disconnectCode?: number | CloseReasons, disconnectReason?: string): void;
-    /**
-     * @done
-     */
     reconnect(disconnectCode: number | CloseReasons, disconnectReason: string, delay?: number): void;
     /**
-     * @done
      * @param lastMessageId
      */
     setLastMessageId(lastMessageId: string): void;
     /**
-     * @done
-     *
-     * Send single message to the specified users.
+     * Send a single message to the specified users.
      *
      * @param users User ids of the message receivers.
-     * @param moduleId Name of the module to receive message,
+     * @param moduleId Name of the module to receive a message,
      * @param command Command name.
      * @param {object} params Command parameters.
      * @param [expiry] Message expiry time in seconds.
@@ -2561,11 +2537,10 @@ declare class PullClient implements ConnectorParent {
      */
     sendMessage(users: number[], moduleId: string, command: string, params: any, expiry?: number): Promise<any>;
     /**
-     * @done
-     * Send single message to the specified public channels.
+     * Send a single message to the specified public channels.
      *
-     * @param  publicChannels Public ids of the channels to receive message.
-     * @param moduleId Name of the module to receive message,
+     * @param  publicChannels Public ids of the channels to receive a message.
+     * @param moduleId Name of the module to receive a message,
      * @param command Command name.
      * @param {object} params Command parameters.
      * @param [expiry] Message expiry time in seconds.
@@ -2573,12 +2548,10 @@ declare class PullClient implements ConnectorParent {
      */
     sendMessageToChannels(publicChannels: string[], moduleId: string, command: string, params: any, expiry?: number): Promise<any>;
     /**
-     * @done
      * @param debugFlag
      */
     capturePullEvent(debugFlag?: boolean): void;
     /**
-     * @done
      * @param loggingFlag
      */
     enableLogging(loggingFlag?: boolean): void;
@@ -2589,57 +2562,40 @@ declare class PullClient implements ConnectorParent {
      */
     listChannels(): Promise<any>;
     /**
-     * @done
-     * Returns "last seen" time in seconds for the users. Result format: Object{userId: int}
+     * Returns "last seen" time in seconds for the users.
+     * Result format: Object{userId: int}
      * If the user is currently connected - will return 0.
-     * If the user if offline - will return diff between current timestamp and last seen timestamp in seconds.
-     * If the user was never online - the record for user will be missing from the result object.
+     * If the user is offline - will return the diff between the current timestamp and the last seen timestamp in seconds.
+     * If the user was never online - the record for the user will be missing from the result object.
      *
      * @param {integer[]} userList List of user ids.
      * @returns {Promise}
      */
     getUsersLastSeen(userList: number[]): Promise<Record<number, number>>;
     /**
-     * @done
-     * Pings server. In case of success promise will be resolved, otherwise - rejected.
+     * Pings server.
+     * In case of success promise will be resolved, otherwise - rejected.
      *
      * @param {number} timeout Request timeout in seconds
      * @returns {Promise}
      */
     ping(timeout?: number): Promise<void>;
     /**
-     * @done
      * @param userId {number}
      * @param callback {UserStatusCallback}
      * @returns {Promise}
      */
     subscribeUserStatusChange(userId: number, callback: UserStatusCallback): Promise<void>;
     /**
-     * @done
      * @param {number} userId
      * @param {UserStatusCallback} callback
      * @returns {Promise}
      */
     unsubscribeUserStatusChange(userId: number, callback: UserStatusCallback): Promise<void>;
-    /**
-     * @done
-     */
     getRevision(): number | null;
-    /**
-     * @done
-     */
     getServerVersion(): number;
-    /**
-     * @done
-     */
     getServerMode(): string | null;
-    /**
-     * @done
-     */
     getConfig(): null | TypePullClientConfig;
-    /**
-     * @done
-     */
     getDebugInfo(): any;
     /**
      * @process
@@ -2650,44 +2606,16 @@ declare class PullClient implements ConnectorParent {
      * @process
      */
     getPublicationPath(): string;
-    /**
-     * @done
-     */
     isConnected(): boolean;
-    /**
-     * @done
-     */
     isWebSocketSupported(): boolean;
-    /**
-     * @done
-     */
     isWebSocketAllowed(): boolean;
-    /**
-     * @done
-     */
     isWebSocketEnabled(): boolean;
-    /**
-     * @done
-     */
     isPublishingSupported(): boolean;
-    /**
-     * @done
-     */
     isPublishingEnabled(): boolean;
-    /**
-     * @done
-     */
     isProtobufSupported(): boolean;
-    /**
-     * @done
-     */
     isJsonRpc(): boolean;
-    /**
-     * @done
-     */
     isSharedMode(): boolean;
     /**
-     * @dones
      * @param {TypePullClientEmitConfig} params
      * @returns {boolean}
      */
@@ -2696,18 +2624,15 @@ declare class PullClient implements ConnectorParent {
      * @process
      *
      * @param message
-     * @private
      */
     private broadcastMessage;
     /**
      * @process
      *
      * @param messages
-     * @private
      */
     private broadcastMessages;
     /**
-     * @done
      * Sends batch of messages to the multiple public channels.
      *
      * @param messageBatchList Array of messages to send.
@@ -2715,123 +2640,70 @@ declare class PullClient implements ConnectorParent {
      */
     private sendMessageBatch;
     /**
-     * @done
      * @param messageBatchList
      * @param publicIds
      */
     private encodeMessageBatch;
     /**
-     * @done
      * @memo fix return type
      * @param users
      * @param publicIds
      */
     private createMessageReceivers;
     /**
-     * @done
      * @param userId
      * @param isOnline
-     * @private
      */
     private emitUserStatusChange;
-    /**
-     * @done
-     * @private
-     */
     private restoreUserStatusSubscription;
     /**
-     * @done
-     *
      * @param logTag
-     * @private
      */
     private loadConfig;
     /**
-     * @done
      * @param config
      */
     private isConfigActual;
-    /**
-     * @done
-     * @private
-     */
     private startCheckConfig;
-    /**
-     * @done
-     */
     private stopCheckConfig;
-    /**
-     * @done
-     * @private
-     */
     private checkConfig;
     /**
-     * @done
-     *
      * @param config
      * @param allowCaching
-     * @private
      */
     private setConfig;
-    /**
-     * @done
-     */
     private setPublicIds;
     /**
-     * @done
      * @param serverRevision
-     * @private
      */
     private checkRevision;
-    /**
-     * @done
-     */
     private disconnect;
-    /**
-     * @done
-     */
     private restoreWebSocketConnection;
     /**
-     * @done
      * @param connectionDelay
-     * @private
      */
     private scheduleReconnect;
-    /**
-     * @done
-     * @private
-     */
     private scheduleRestoreWebSocketConnection;
     /**
-     * @done
      * @returns {Promise}
      */
     private connect;
     /**
-     * @done
      * @param disconnectCode
      * @param disconnectReason
      * @param restartDelay
-     * @private
      */
     private scheduleRestart;
     /**
-     * @done
-     *
      * @param messageFields
-     * @private
      */
     private handleRpcIncomingMessage;
     /**
-     * @done
      * @param events
-     * @private
      */
     private handleIncomingEvents;
     /**
-     * @done
      * @param event
-     * @private
      */
     private updateSessionFromEvent;
     /**
@@ -2839,150 +2711,89 @@ declare class PullClient implements ConnectorParent {
      *
      * @param command
      * @param message
-     * @private
      */
     private handleInternalPullEvent;
     /**
-     * @done
      * @param response
-     * @private
      */
     private onIncomingMessage;
-    /**
-     * @done
-     */
     private onLongPollingOpen;
     /**
-     * @done
      * @param response
-     * @private
      */
     private onLongPollingDisconnect;
     /**
-     * @done
      * @param error
      */
     private onLongPollingError;
     /**
-     * @done
      * @param response
-     * @private
      */
     private onWebSocketBlockChanged;
-    /**
-     * @done
-     */
     private onWebSocketOpen;
     /**
-     * @done
      * @param response
-     * @private
      */
     private onWebSocketDisconnect;
     /**
-     * @done
      * @param error
      */
     private onWebSocketError;
     /**
-     * @done
      * @param pullEvent
-     * @private
      */
     private extractMessages;
     /**
-     * @done
      * @param pullEvent
-     * @private
      */
     private extractProtobufMessages;
     /**
-     * @done
      * @param pullEvent
-     * @private
      */
     private extractPlainTextMessages;
     /**
-     * @done
      * Converts message id from byte[] to string
      * @param {Uint8Array} encodedId
      * @return {string}
      */
     private decodeId;
     /**
-     * @done
      * Converts message id from hex-encoded string to byte[]
      * @param {string} id Hex-encoded string.
      * @return {Uint8Array}
      */
     private encodeId;
-    /**
-     * @done
-     */
     private onOffline;
-    /**
-     * @done
-     */
     private onOnline;
-    /**
-     * @done
-     * @private
-     */
     private onBeforeUnload;
     /**
-     * @done
      * @param status
      * @param delay
-     * @private
      */
     private sendPullStatusDelayed;
     /**
-     * @done
      * @param status
-     * @private
      */
     private sendPullStatus;
     /**
-     * @done
-     * @memo if private ?
+     * @memo if private?
      * @param tagId
      * @param force
      */
     private extendWatch;
     /**
-     * @done
      * @param force
-     * @private
      */
     private updateWatch;
     /**
-     * @done
      * @param tagId
-     * @private
      */
     private clearWatch;
-    /**
-     * @done
-     * @private
-     */
     private onJsonRpcPing;
-    /**
-     * @done
-     * @private
-     */
     private updatePingWaitTimeout;
-    /**
-     * @done
-     * @private
-     */
     private clearPingWaitTimeout;
-    /**
-     * @done
-     * @private
-     */
     private onPingTimeout;
     /**
-     * @done
      * Returns reconnect delay in seconds
      *
      * @param attemptNumber
@@ -2990,43 +2801,30 @@ declare class PullClient implements ConnectorParent {
      */
     private getConnectionAttemptDelay;
     /**
-     * @done
      * @param mid
      */
     private checkDuplicate;
-    /**
-     * @done
-     */
     private trimDuplicates;
     /**
-     * @done
      * @param message
-     * @private
      */
     private logMessage;
     /**
-     * @done
      * @param message
      * @param force
-     * @private
      */
     private logToConsole;
     /**
-     * @done
      * @param message
-     * @private
      */
     private addMessageToStat;
     /**
-     * @done
-     *
      * @param text
      */
     private showNotification;
     /**
-     * @done
-     * @memo may be need use onCustomEvent
-     * @memo wtf ? force
+     * @memo may be need to use onCustomEvent
+     * @memo ? force
      */
     private onCustomEvent;
 }