@bitrix24/b24jssdk 0.1.7 → 0.2.1

package/dist/esm/index.d.mts

@@ -294,6 +294,10 @@ declare class TypeManager {
 }
 declare const Type: TypeManager;
 
+declare function pick<Data extends object, Keys extends keyof Data>(data: Data, keys: Keys[]): Pick<Data, Keys>;
+declare function omit<Data extends object, Keys extends keyof Data>(data: Data, keys: Keys[]): Omit<Data, Keys>;
+declare function isArrayOfArray<A>(item: A[] | A[][]): item is A[][];
+
 /**
  * The `Text` class provides a set of utility methods for working with text data.
  * It includes functions for encoding and decoding HTML entities, generating random strings,
@@ -383,50 +387,59 @@ declare const Browser: BrowserManager;
 /**
  * Interface defining the structure and methods of a Result object.
  */
-interface IResult {
+interface IResult<T = any> {
     /**
      * Indicates whether the operation resulted in success (no errors).
      */
-    isSuccess: boolean;
+    readonly isSuccess: boolean;
+    /**
+     * Collection of errors
+     */
+    readonly errors: Map<string, Error>;
     /**
      * Sets the data associated with the result.
      *
      * @param data The data to be stored in the result.
      * @returns The current Result object for chaining methods.
      */
-    setData: (data: any) => IResult;
+    setData: (data: T) => IResult<T>;
     /**
      * Retrieves the data associated with the result.
      *
      * @returns The data stored in the result, if any.
      */
-    getData: () => any;
+    getData: () => T | null;
     /**
      * Adds an error message or Error object to the result.
-     *
      * @param error The error message or Error object to be added.
-     * @returns The current Result object for chaining methods.
+     * @param key Error key. You can leave it blank. Then it will be generated automatically.
+     * @returns {IResult} The current Result object for chaining methods.
      */
-    addError: (error: Error | string) => IResult;
+    addError: (error: Error | string, key?: string) => IResult;
     /**
      * Adds multiple errors to the result in a single call.
      *
      * @param errors An array of errors or strings that will be converted to errors.
-     * @returns The current Result object for chaining methods.
+     * @returns {IResult} The current Result object for chaining methods.
      */
     addErrors: (errors: (Error | string)[]) => IResult;
     /**
      * Retrieves an iterator for the errors collected in the result.
      *
-     * @returns An iterator over the stored Error objects.
+     * @returns {IterableIterator<Error>} An iterator over the stored Error objects.
      */
     getErrors: () => IterableIterator<Error>;
     /**
      * Retrieves an array of error messages from the collected errors.
      *
-     * @returns An array of strings representing the error messages.
+     * @returns {string[]} An array of strings representing the error messages.
      */
     getErrorMessages: () => string[];
+    /**
+     * Checks for an error in a collection by key
+     * @param key - Error key
+     */
+    hasError(key: string): boolean;
     /**
      * Converts the Result object to a string.
      *
@@ -439,49 +452,18 @@ interface IResult {
  * Similar to \Bitrix\Main\Result from Bitrix Framework.
  * @link https://dev.1c-bitrix.ru/api_d7/bitrix/main/result/index.php
  */
-declare class Result implements IResult {
-    private _errorCollection;
-    protected _data: any;
-    constructor();
-    /**
-     * Getter for the `isSuccess` property.
-     * Checks if the `_errorCollection` is empty to determine success.
-     *
-     * @returns Whether the operation resulted in success (no errors).
-     */
+declare class Result<T = any> implements IResult<T> {
+    protected _errors: Map<string, Error>;
+    protected _data: T | null;
+    constructor(data?: T);
     get isSuccess(): boolean;
-    /**
-     * Sets the data associated with the result.
-     *
-     * @param data The data to be stored in the result.
-     * @returns The current Result object for chaining methods.
-     */
-    setData(data: any): Result;
-    /**
-     * Retrieves the data associated with the result.
-     *
-     * @returns The data stored in the result, if any.
-     */
-    getData(): any;
-    /**
-     * Adds an error message or Error object to the result.
-     *
-     * @param error The error message or Error object to be added.
-     * @returns The current Result object for chaining methods.
-     */
-    addError(error: Error | string): Result;
-    /**
-     * Adds multiple errors to the result in a single call.
-     *
-     * @param errors An array of errors or strings that will be converted to errors.
-     * @returns The current Result object for chaining methods.
-     */
-    addErrors(errors: (Error | string)[]): Result;
-    /**
-     * Retrieves an iterator for the errors collected in the result.
-     * @returns An iterator over the stored Error objects.
-     */
+    get errors(): Map<string, Error>;
+    setData(data: T | null): Result<T>;
+    getData(): T | null;
+    addError(error: Error | string, key?: string): Result<T>;
+    addErrors(errors: (Error | string)[]): Result<T>;
     getErrors(): IterableIterator<Error>;
+    hasError(key: string): boolean;
     /**
      * Retrieves an array of error messages from the collected errors.
      *
@@ -495,6 +477,10 @@ declare class Result implements IResult {
      * @returns {string} Returns a string representation of the result operation
      */
     toString(): string;
+    private safeStringify;
+    private replacer;
+    static ok<U>(data?: U): Result<U>;
+    static fail<U>(error: Error | string, key?: string): Result<U>;
 }
 
 type PayloadTime = {
@@ -538,36 +524,52 @@ type BatchPayload<C> = {
 };
 type Payload<P> = GetPayload<P> | ListPayload<P> | BatchPayload<P>;
 
-type AjaxQuery = {
+type AjaxQuery = Readonly<{
     method: string;
-    params: object;
+    params: Readonly<object>;
     start: number;
-};
-type AjaxResultParams = {
+}>;
+type AjaxResultParams<T = unknown> = Readonly<{
     error?: string | {
         error: string;
-        error_description: string;
+        error_description?: string;
     };
     error_description?: string;
-    result: any;
+    result: T;
     next?: NumberString;
     total?: NumberString;
-};
+    time: PayloadTime;
+}>;
+type AjaxResultOptions<T> = Readonly<{
+    answer: AjaxResultParams<T>;
+    query: AjaxQuery;
+    status: number;
+}>;
 /**
  * Result of request to Rest Api
  */
-declare class AjaxResult extends Result implements IResult {
+declare class AjaxResult<T = unknown> extends Result<Payload<T>> implements IResult<Payload<T>> {
+    #private;
     private readonly _status;
     private readonly _query;
-    protected _data: AjaxResultParams;
-    constructor(answer: AjaxResultParams, query: AjaxQuery, status: number);
-    setData(data: any): Result;
-    getData(): Payload<unknown>;
+    protected _data: AjaxResultParams<T>;
+    constructor(options: AjaxResultOptions<T>);
+    getData(): Payload<T>;
+    /**
+     * Alias for isMore
+     */
+    hasMore(): boolean;
     isMore(): boolean;
     getTotal(): number;
     getStatus(): number;
-    getQuery(): AjaxQuery;
-    getNext(http: TypeHttp): Promise<false | AjaxResult>;
+    getQuery(): Readonly<AjaxQuery>;
+    /**
+     * Alias for getNext
+     * @param http
+     */
+    fetchNext(http: TypeHttp): Promise<AjaxResult<T> | null>;
+    getNext(http: TypeHttp): Promise<AjaxResult<T> | false>;
+    setData(): never;
 }
 
 type TypeHttp = {
@@ -1360,18 +1362,81 @@ type AjaxErrorParams = {
     answerError: AnswerError;
     cause?: Error;
 };
+type ErrorDetails = {
+    code: string;
+    description?: string;
+    status: number;
+    requestInfo?: {
+        method?: string;
+        url?: string;
+        params?: Record<string, unknown> | unknown;
+    };
+    originalError?: unknown;
+};
 /**
  * Error requesting RestApi
  */
 declare class AjaxError extends Error {
-    cause: null | Error;
+    readonly code: string;
     private _status;
-    private _answerError;
-    constructor(params: AjaxErrorParams);
+    readonly requestInfo?: ErrorDetails['requestInfo'];
+    readonly timestamp: Date;
+    readonly originalError?: unknown;
+    constructor(details: ErrorDetails);
+    /**
+     * @deprecated
+     */
     get answerError(): AnswerError;
     get status(): number;
+    /**
+     * @deprecated
+     */
     set status(status: number);
+    /**
+     * Creates AjaxError from HTTP response
+     */
+    static fromResponse(response: {
+        status: number;
+        data?: {
+            error?: string;
+            error_description?: string;
+        };
+        config?: {
+            method?: string;
+            url?: string;
+            params?: unknown;
+        };
+    }): AjaxError;
+    /**
+     * Creates AjaxError from exception
+     */
+    static fromException(error: unknown, context?: {
+        code?: string;
+        status?: number;
+        requestInfo?: ErrorDetails['requestInfo'];
+    }): AjaxError;
+    /**
+     * Serializes error for logging and debugging
+     */
+    toJSON(): {
+        name: string;
+        code: string;
+        message: string;
+        status: number;
+        timestamp: string;
+        requestInfo: {
+            method?: string;
+            url?: string;
+            params?: Record<string, unknown> | unknown;
+        } | undefined;
+        stack: string | undefined;
+    };
+    /**
+     * Formats error information for human-readable output
+     */
     toString(): string;
+    private static formatErrorMessage;
+    private cleanErrorStack;
 }
 
 declare abstract class AbstractB24 implements TypeB24 {
@@ -1724,11 +1789,13 @@ declare class AppFrame {
  * Parent Window Request Parameters
  * @prop isSafely auto completion mode Promise.resolve()
  * @prop safelyTime after what time (900 ms) should it be automatically resolved Promise
+ * @prop callBack for placement event
  */
 interface SendParams {
     [index: string]: any;
     isSafely?: boolean;
     safelyTime?: number;
+    callBack?: (...args: any[]) => void;
 }
 /**
  * Parent Window Communication Manager at B24
@@ -1736,7 +1803,7 @@ interface SendParams {
 declare class MessageManager {
     #private;
     protected _logger: null | LoggerBrowser;
-    private runCallbackHandler;
+    private readonly runCallbackHandler;
     constructor(appFrame: AppFrame);
     setLogger(logger: LoggerBrowser): void;
     getLogger(): LoggerBrowser;
@@ -2162,11 +2229,12 @@ declare class PlacementManager {
     /**
      * Set Up the Interface Event Handler
      * @param {string} eventName
+     * @param {(...args: any[]) => void} callBack
      * @return {Promise<any>}
      *
      * @link https://apidocs.bitrix24.com/api-reference/widgets/ui-interaction/bx24-placement-bind-event.html
      */
-    bindEvent(eventName: string): Promise<any>;
+    bindEvent(eventName: string, callBack: (...args: any[]) => void): Promise<any>;
     /**
      * Call the Registered Interface Command
      * @param {string} command
@@ -2868,4 +2936,4 @@ declare class PullClient implements ConnectorParent {
 
 declare function initializeB24Frame(): Promise<B24Frame>;
 
-export { AbstractB24, AjaxError, type AjaxErrorParams, type AjaxQuery, AjaxResult, type AjaxResultParams, type AnswerError, AppFrame, type AuthActions, type AuthData, AuthHookManager, AuthManager, B24Frame, type B24FrameQueryParams, B24Hook, type B24HookParams, B24LangList, PullClient as B24PullClientManager, type BatchPayload, type BoolString, Browser, CloseReasons, type CommandHandlerFunctionV1, type CommandHandlerFunctionV2, ConnectionType, type ConnectorCallbacks, type ConnectorConfig, type ConnectorParent, type Currency, type CurrencyFormat, DataType, DialogManager, EnumAppStatus, EnumCrmEntityType, EnumCrmEntityTypeId, type Fields, type GenderString, type GetPayload, type IPlacementUF, type IRequestIdGenerator, type IResult, type ISODate, type JsonRpcRequest, type ListPayload, ListRpcError, LoadDataType, LoggerBrowser, LoggerType, LsKeys, MessageCommands, type MessageInitData, MessageManager, type MultiField, type MultiFieldArray, type NumberString, OptionsManager$1 as OptionsManager, ParentManager, type Payload, type PayloadTime, PlacementManager, type PlacementViewMode, PullStatus, type RefreshAuthData, RestrictionManagerParamsBase, RestrictionManagerParamsForEnterprise, Result, type RpcCommand, type RpcCommandResult, type RpcError, RpcMethod, type RpcRequest, type SelectCRMParams, type SelectCRMParamsEntityType, type SelectCRMParamsValue, type SelectedAccess, type SelectedCRM, type SelectedCRMEntity, type SelectedUser, type SendParams, SenderType, ServerMode, type SharedConfigCallbacks, type SharedConfigParams, SliderManager, type StatusClose, StatusDescriptions, type StorageManagerParams, SubscriptionType, SystemCommands, Text, Type, type TypeApp, type TypeB24, type TypeB24Form, type TypeChanel, type TypeChannelManagerParams, type TypeConnector, type TypeDescriptionError, type TypeEnumAppStatus, type TypeHttp, type TypeJsonRpcConfig, type TypeLicense, TypeOption, type TypePayment, type TypePublicIdDescriptor, type TypePullClientConfig, type TypePullClientEmitConfig, type TypePullClientMessageBatch, type TypePullClientMessageBody, type TypePullClientParams, type TypePullClientSession, type TypePullMessage, type TypeRestrictionManagerParams, type TypeRpcResponseAwaiters, type TypeSessionEvent, TypeSpecificUrl, type TypeStorageManager, type TypeSubscriptionCommandHandler, type TypeSubscriptionOptions, type TypeUser, type UserBasic, type UserBrief, type UserFieldType, type UserStatusCallback, initializeB24Frame, useB24Helper, useFormatter };
+export { AbstractB24, AjaxError, type AjaxErrorParams, type AjaxQuery, AjaxResult, type AjaxResultParams, type AnswerError, AppFrame, type AuthActions, type AuthData, AuthHookManager, AuthManager, B24Frame, type B24FrameQueryParams, B24Hook, type B24HookParams, B24LangList, PullClient as B24PullClientManager, type BatchPayload, type BoolString, Browser, CloseReasons, type CommandHandlerFunctionV1, type CommandHandlerFunctionV2, ConnectionType, type ConnectorCallbacks, type ConnectorConfig, type ConnectorParent, type Currency, type CurrencyFormat, DataType, DialogManager, EnumAppStatus, EnumCrmEntityType, EnumCrmEntityTypeId, type Fields, type GenderString, type GetPayload, type IPlacementUF, type IRequestIdGenerator, type IResult, type ISODate, type JsonRpcRequest, type ListPayload, ListRpcError, LoadDataType, LoggerBrowser, LoggerType, LsKeys, MessageCommands, type MessageInitData, MessageManager, type MultiField, type MultiFieldArray, type NumberString, OptionsManager$1 as OptionsManager, ParentManager, type Payload, type PayloadTime, PlacementManager, type PlacementViewMode, PullStatus, type RefreshAuthData, RestrictionManagerParamsBase, RestrictionManagerParamsForEnterprise, Result, type RpcCommand, type RpcCommandResult, type RpcError, RpcMethod, type RpcRequest, type SelectCRMParams, type SelectCRMParamsEntityType, type SelectCRMParamsValue, type SelectedAccess, type SelectedCRM, type SelectedCRMEntity, type SelectedUser, type SendParams, SenderType, ServerMode, type SharedConfigCallbacks, type SharedConfigParams, SliderManager, type StatusClose, StatusDescriptions, type StorageManagerParams, SubscriptionType, SystemCommands, Text, Type, type TypeApp, type TypeB24, type TypeB24Form, type TypeChanel, type TypeChannelManagerParams, type TypeConnector, type TypeDescriptionError, type TypeEnumAppStatus, type TypeHttp, type TypeJsonRpcConfig, type TypeLicense, TypeOption, type TypePayment, type TypePublicIdDescriptor, type TypePullClientConfig, type TypePullClientEmitConfig, type TypePullClientMessageBatch, type TypePullClientMessageBody, type TypePullClientParams, type TypePullClientSession, type TypePullMessage, type TypeRestrictionManagerParams, type TypeRpcResponseAwaiters, type TypeSessionEvent, TypeSpecificUrl, type TypeStorageManager, type TypeSubscriptionCommandHandler, type TypeSubscriptionOptions, type TypeUser, type UserBasic, type UserBrief, type UserFieldType, type UserStatusCallback, initializeB24Frame, isArrayOfArray, omit, pick, useB24Helper, useFormatter };