d5-api-initializer 1.7.4 → 1.8.0

package/publish/d5-api-initializer.d.cts

@@ -0,0 +1,776 @@
+type SendZipJsWapiArgs = {
+    name: string;
+    contentType?: string;
+    callback: (zip: any) => void;
+};
+type SendFileJsWapiArgs = {
+    name: string;
+    contentType?: string;
+    file: {
+        object: string;
+        oper: string;
+        keyValue: any;
+        field: string;
+    };
+};
+declare namespace jsWapi {
+    interface JSRequestModesSetter {
+        setAutocompleteLinkedObjectFields(isAutocompleteLinkedObjectFields: boolean): void;
+        setAutocompleteKeyField(isAutocompleteKeyField: boolean): void;
+    }
+    type JSWapiInvoker = {
+        putRequestModes(cb: (rm: JSRequestModesSetter) => void): JSWapiInvoker;
+        setFilters(filters: any): JSWapiInvoker;
+        setParams(params: any): JSWapiInvoker;
+        setRowsPerPage(number: number): JSWapiInvoker;
+        setPage(number: number): JSWapiInvoker;
+        setPagesPredict(number: number): JSWapiInvoker;
+        setColumns(columns: string[]): JSWapiInvoker;
+        addColumns(columns: string[]): JSWapiInvoker;
+        setSorts(sorts: string[]): JSWapiInvoker;
+        addSorts(sorts: string[]): JSWapiInvoker;
+        setAggregatedColumns(columns: any): JSWapiInvoker;
+        putAggregatedColumns(columns: any): JSWapiInvoker;
+        putAggregatedFilter(name: string, value: any): JSWapiInvoker;
+        putAggregatedFilters(filters: IFiltersCollection): JSWapiInvoker;
+        setNestedColumns(columns: any): JSWapiInvoker;
+        putNestedColumns(columns: any): JSWapiInvoker;
+        putFilters(filters: IFiltersCollection): JSWapiInvoker;
+        setHierarchy(parentColumn: string, requestKind?: number): JSWapiInvoker;
+        setSrcRequest(srcRequest: any): JSWapiInvoker;
+        setFirstRows(number: number): JSWapiInvoker;
+        setOperRightCheck(check: boolean): JSWapiInvoker;
+        putRequest(objectName: string, req: any): JSWapiInvoker;
+        setRequest(req: any): JSWapiInvoker;
+        getRequest(objectName?: string): Record<string, any>[];
+        getSrcRequest(): Record<string, any>[];
+        getFirstRows(): number;
+        setKeyValue(keyValue: number | string): JSWapiInvoker;
+        setSingleColumn(column: string): JSWapiInvoker;
+        invokeAndGetFileAsString(): string;
+        invokeAndGetExcelFileAsJson(): Map<string, any>;
+        addRequestRow(row: Record<string, any>): JSWapiInvoker;
+        addFile(fileID: string, file: any): JSWapiInvoker;
+        invoke(): JSWapiResponse;
+    };
+    type JSWapiRequest = {
+        getColumns(): string[];
+        getSorts(): string[];
+        getAggregatedColumns(): any;
+        getNestedColumns(): any;
+        getFilters(): any;
+        getParams(): any;
+        getUserId(): number;
+        getPage(): number;
+        addSorts(sorts: string[]): JSWapiRequest;
+        putAggregatedColumns(columns: any): JSWapiRequest;
+        addColumns(columns: string[]): JSWapiRequest;
+        putNestedColumns(columns: Record<string, any>): JSWapiRequest;
+        putFilters(filters: IFiltersCollection): JSWapiRequest;
+        putParam(params: Record<string, any>): JSWapiRequest;
+        removeSorts(sortsNames: string[]): JSWapiRequest;
+        removeColumns(columnsNames: string[]): JSWapiRequest;
+        removeAggregatedColumns(aggregatedColumnsNames: string[]): JSWapiRequest;
+        removeNestedColumns(nestedColumnsNames: string[]): JSWapiRequest;
+        removeParams(paramsNames: string[]): JSWapiRequest;
+        removeFilters(filtersNames: string[]): JSWapiRequest;
+        isFilterExists(filterName: string): boolean;
+        invoke(): JSWapiResponse;
+        newJSWapiInvoker(objectName: string, operName: string): JSWapiInvoker;
+        getFirstRows(): number;
+        getRowsPerPage(): number;
+        getLanguage(): string;
+        pdf(): JSWapiPdf;
+        zip(): JSWapiZip;
+        xls(): JSWapiXls;
+        getMultiFileAsString(...arg: string[]): any;
+        getMultiExcelFileAsJson(...arg: string[]): any;
+        getRequest(object: string): Record<string, any>[];
+        getFilter(filterName: string): any;
+        getFilterEqualOneValue(filterName: string): any;
+        getParam(filterName: string): any;
+        getExcelFileAsJson(fileRequestId: string): any;
+        getFileAsString(fileRequestId: string): any;
+        setColumns(columns: string[]): JSWapiRequest;
+        setSorts(sorts: string[]): JSWapiRequest;
+        setAggregatedColumns(columns: any): JSWapiRequest;
+        setNestedColumns(columns: any): JSWapiRequest;
+        setFilters(filters: any): JSWapiRequest;
+        setParams(params: any): JSWapiRequest;
+        setPage(number: number): JSWapiRequest;
+        setRowsPerPage(number: number): JSWapiRequest;
+        setFirstRows(number: number): JSWapiRequest;
+        setRequest(request: any): JSWapiRequest;
+        putRequest(objectName: string, req: any): JSWapiRequest;
+        setHierarchy(parentColumn: string, requestKind?: number): JSWapiRequest;
+        getAggregatedFilter(name: string): any;
+        getAggregatedFilters(): any;
+        putAggregatedFilter(name: string, value: any): any;
+        putAggregatedFilters(filters: any): any;
+        removeAggregatedFilter(name: string): any;
+        removeAggregatedFilters(names: string[]): any;
+    };
+    type JSWapiResponse = {
+        getResponse(): {
+            [key: string]: Record<string, any>[];
+        };
+        getResponse(objectName: string): Record<string, any>[] | null;
+        putResponse(objectName: string, records: Record<string, any>[]): void;
+        setResponse(resp: {
+            [key: string]: Record<string, any>[];
+        }): void;
+        sendHttpResponse(body: string | BinaryDataStream): void;
+        sendHttpResponse(headers: Record<string, any>, body: string | BinaryDataStream): void;
+        getPagesPredict(): number;
+        sendZip({ name, contentType, callback }: SendZipJsWapiArgs): void;
+        sendFile({ name, contentType, file }: SendFileJsWapiArgs): void;
+        setPagesPredict(pagesPredict: number): void;
+        getPage(): number;
+        setPage(page: number): void;
+    };
+    type BinaryDataStream = unknown;
+    interface JSWapiHttpResponse {
+        getStatusCode(): number;
+        getBody(): string;
+        getBodyAsInputStream(): BinaryDataStream;
+        getHeader(name: string): string;
+        isSuccessful(): boolean;
+    }
+    type IHttpCallback = (resp: JSWapiHttpResponse) => any;
+    interface JSWapiHttp {
+        setHeader(key: string, value: string): JSWapiHttp;
+        setTimeout(milliseconds: number): JSWapiHttp;
+        GET(cb: IHttpCallback): any;
+        POST(body: string, cb: IHttpCallback): any;
+        POST(body: (req: JSWapiHttpRequest) => JSWapiHttpRequest, cb: IHttpCallback): any;
+        DELETE(body: string, cb: IHttpCallback): any;
+        PUT(body: string, cb: IHttpCallback): any;
+        PATCH(body: string, cb: IHttpCallback): any;
+    }
+    interface JSWapiHttpRequest {
+        setBody(body: string): JSWapiHttpRequest;
+        setBody(bodySetter: (body: JSWapiHttpRequestBody) => JSWapiHttpRequestBody): JSWapiHttpRequest;
+        setMultipartBody(bodySetter: (body: JSWapiMultipartBody) => JSWapiMultipartBody): JSWapiHttpRequest;
+    }
+    interface JSWapiHttpRequestBody {
+        setFileLink(fileLink: string): JSWapiHttpRequestBody;
+        setFileRequestId(id: string): JSWapiHttpRequestBody;
+    }
+    interface JSWapiMultipartBody {
+        addPart(name: string, value: string): JSWapiMultipartBody;
+        addFilePart(name: string, fileName: string, cb: (body: JSWapiMultipartBodyFilePart) => JSWapiMultipartBodyFilePart): JSWapiMultipartBody;
+    }
+    interface JSWapiMultipartBodyFilePart {
+        setFileLink(fileLink: string): JSWapiMultipartBodyFilePart;
+        setFileRequestId(id: string): JSWapiMultipartBodyFilePart;
+        setBody(body: string): JSWapiMultipartBodyFilePart;
+    }
+    type JSWapiMeta<Params = {}> = {
+        parameters?: Params;
+        externalObject?: string;
+        objectName: string;
+        externalFieldsMap?: Record<string, string>;
+    };
+    interface JSWapiObject {
+        getName(): string;
+        newJSWapiHttp(url: string): JSWapiHttp;
+        putJSWapiOper(operation: string, callback: (request: JSWapiRequest, response: JSWapiResponse) => void): void;
+    }
+    function putJSWapiObject(objectName: string, init: (object: JSWapiObject) => void): void;
+    interface JSWapiEngine {
+        getExternalName(): string;
+        getExternalObjectFields(): Record<string, string>;
+        getExternalSystemParameters(): Record<string, any>;
+        getName(): string;
+        newJSWapiHttp(url: string): JSWapiHttp;
+        putJSWapiOper(operation: string, callback: (jsWapiRequest: JSWapiRequest, jsWapiResponse: JSWapiResponse) => void): void;
+    }
+    function setJSWapiEngine(init: (object: JSWapiEngine) => void): void;
+    interface JSWapiApplication {
+        getName(): string;
+        newJSWapiHttp(url: string): JSWapiHttp;
+        putJSWapiOper(operation: string, callback: (request: JSWapiRequest, response: JSWapiResponse) => void): void;
+    }
+    function setJSWapiObject(init: (object: JSWapiApplication) => void): void;
+    type JSWapiPdfLoadParamsObject = {
+        object: string;
+        field: string;
+        keyValue: any;
+        callback: (pdf: JSWapiPdfDocument) => void;
+    };
+    type JSWapiPdfLoadParamsReport = {
+        report: {
+            type: 'dx' | 'xls';
+            name: string;
+            params: Record<string, any>;
+        } | {
+            type: 'tax';
+            code: string;
+            params: Record<string, any>;
+        };
+        callback: (pdf: JSWapiPdfDocument) => void;
+    };
+    type JSWapiPdfLoadParams = JSWapiPdfLoadParamsObject | JSWapiPdfLoadParamsReport;
+    type JSWapiStampPosition = {
+        page: number;
+        x: number;
+        y: number;
+    };
+    interface JSWapiPdfDocument {
+        save(params: {
+            object: string;
+            keyValue: any;
+            field: string;
+            fileName: string;
+        }): void;
+        /**
+         * На поточний документ накласти печать stampPdf
+         * @param stampPdf PDF документ на который будет наложено текущий документ
+         * @param params
+         * @param params.page номер страницы, на которую накладывать. Если page < 0, то нумерация с конца (т.е. page = -1 - последняя страница)
+         * @param params.x координата левого угла в мм
+         * @param params.y координата верхнего угла в мм
+         */
+        overlay(stampPdf: JSWapiPdfDocument, params: JSWapiStampPosition): void;
+        /**
+         * Ширина страницы в мм
+         * @param pageNumber Номер страницы. Если pageNumber < 0, то нумеровать с конца
+         */
+        getPageWidth(pageNumber: number): number;
+        /**
+         * Высота страницы в мм
+         * @param pageNumber Номер страницы. Если pageNumber < 0, то нумеровать с конца
+         */
+        getPageHeight(pageNumber: number): number;
+        /**
+         * Количество страниц
+         */
+        getPageCount(): number;
+    }
+    interface JSWapiPdf {
+        load(params: JSWapiPdfLoadParams): JSWapiPdf;
+    }
+    interface JSZipEntity {
+        /**
+         * полное имя файла вместе с директориями
+         * @example
+         * zipEntry.name() === "1/2/3/tax.xlsx"
+         */
+        name(): string;
+        /**
+         * true, если это директория
+         */
+        isDirectory(): boolean;
+    }
+    interface JSWapiZip {
+        /**
+         *
+         * @param {Object} params
+         * @param params.callback Функция в callback вызывается для каждого элемента zip-файла.
+         *
+         */
+        unzip(params: {
+            fileRequestId: string;
+            callback: (zipEntry: JSZipEntity) => void;
+        }): JSWapiPdf;
+    }
+    /**
+     * Вернуть содержимое meta-Excel в виде JSON-объекта:
+     {
+     "sheet123": {
+     "TaxBillHeader" : [
+     {"R001G3": "", "R01G1": "", ...}, ...
+     ], ...
+     }, ...
+     }
+     *
+     * @param fileRequestId имя поля в multipart-запросе с Excel-файлом
+     */
+    interface JSWapiXls {
+        getMetaExcelFileAsJson(fileRequestId: string): JSWapiPdf;
+    }
+}
+
+declare class FileLink {
+    private readonly _link;
+    constructor(_link: string);
+    get link(): string;
+}
+declare class FileRequestId {
+    private readonly _id;
+    constructor(_id: string);
+    get id(): string;
+}
+declare function fileLink(link: string): FileLink;
+declare function fileRequestId(id: string): FileRequestId;
+type MultipartFileType = FileRequestId | FileLink | string;
+declare class MultipartFormData {
+    private _formData;
+    private _fileNames;
+    set(name: string, value: unknown): void;
+    set(name: string, file: MultipartFileType, filename: string): void;
+    get(name: string): MultipartFileType | undefined;
+    delete(name: string): void;
+    isFile(name: string): boolean;
+    iterator(): Generator<{
+        name: string;
+        data: MultipartFileType;
+        fileName: string;
+    }, void, unknown>;
+}
+declare class ApiHttpRequest {
+    private _jsWapiHttp;
+    constructor(jsWapiHttp: jsWapi.JSWapiHttp);
+    set headers(headers: Record<string, string>);
+    set timeout(milliseconds: number);
+    setHeader(header: string, value: string): ApiHttpRequest;
+    setHeaders(headers: Record<string, string>): ApiHttpRequest;
+    setTimeout(milliseconds: number): ApiHttpRequest;
+    GET(callback?: IHttpCallback): any;
+    POST(request?: FileLink | FileRequestId | MultipartFormData | Record<string, any> | string, callback?: IHttpCallback): any;
+    private setMultipartBody;
+    PUT(body?: Record<string, any> | string, callback?: IHttpCallback): any;
+    DELETE(body?: Record<string, any> | string, callback?: IHttpCallback): any;
+    PATCH(body: Record<string, any> | string, callback: IHttpCallback): any;
+    private _getWrappedCallback;
+}
+
+type FileEntry = {
+    name: string;
+    objectName?: string;
+    operation?: string;
+    keyValue?: any;
+    field?: string;
+};
+type SendZipOptions = {
+    name: string;
+    contentType?: string;
+    files: FileEntry[];
+};
+type SendFileOptions = {
+    name: string;
+    contentType?: string;
+    file: FileEntry;
+};
+declare class ApiResponse {
+    private _jsWapiResponse;
+    private readonly _objectName;
+    constructor(jsWapiResponse: jsWapi.JSWapiResponse, objectName: string);
+    get objectName(): string;
+    set response(response: IMappedCollection | any[]);
+    getResponse(responseName?: string): IMappedCollection[] | any;
+    getResponseObject(): IMappedCollection[] | any;
+    setResponse(response: IMappedCollection | any[], fieldsMap?: Record<string, any>): this;
+    sendHttpResponse(body: string | jsWapi.BinaryDataStream): ApiResponse;
+    sendHttpResponse(headers: Record<string, string>, body: string | jsWapi.BinaryDataStream): ApiResponse;
+    sendHttpBody(body: string | jsWapi.BinaryDataStream): this;
+    getPage(): number;
+    setPage(page: number): this;
+    getPagesPredict(): number;
+    setPagesPredict(pagesPredict: number): this;
+    sendZip({ name, contentType, files }: SendZipOptions): void;
+    sendFile({ name, contentType, file }: SendFileOptions): void;
+}
+
+interface IInvoker$1<T> {
+    setColumns(columns: string[]): T;
+    setFilters(filters: IFiltersCollection): T;
+    setSorts(sorts: string[]): T;
+    addColumns(columns: string[]): T;
+    addSorts(sorts: string[]): T;
+    setRowsPerPage(amount: number): T;
+    objectName: string;
+}
+declare class ApiInvoker implements IInvoker$1<ApiInvoker> {
+    _jsWapiInvoker: jsWapi.JSWapiInvoker;
+    protected readonly _objectName: string;
+    constructor(jsWapiInvoker: jsWapi.JSWapiInvoker, objectName: string);
+    get objectName(): string;
+    set filters(filters: IFiltersCollection);
+    set params(params: IMappedCollection);
+    set rowsPerPage(amount: number);
+    set page(number: number);
+    set pagesPredict(amount: number);
+    set request(request: IMappedCollection | any[]);
+    get request(): IMappedCollection | any[];
+    set columns(columns: string[]);
+    set sorts(sorts: string[]);
+    set aggregatedColumns(aggregatedColumns: IMappedCollection);
+    set nestedColumns(nestedColumns: IMappedCollection);
+    set autocompleteLinkedObjectFields(value: boolean);
+    set autocompleteKeyField(value: boolean);
+    setAutocompleteLinkedObjectFields(value: boolean): this;
+    setAutocompleteKeyField(value: boolean): this;
+    setHierarchy(parentColumn: string, requestKind?: number): this;
+    setFilters(filters: IFiltersCollection): ApiInvoker;
+    setParams(params: IMappedCollection): ApiInvoker;
+    setPage(number: number): ApiInvoker;
+    setRowsPerPage(amount: number): ApiInvoker;
+    setPagesPredict(amount: number): ApiInvoker;
+    setRequest(request: IMappedCollection | any[]): ApiInvoker;
+    getRequest(requestName: string): IMappedCollection[];
+    setSrcRequest(srcRequest: IMappedCollection): ApiInvoker;
+    getSrcRequest(): Record<string, any>;
+    setColumns(columns: string[]): ApiInvoker;
+    setAggregatedColumns(aggregatedColumns: IMappedCollection): ApiInvoker;
+    setNestedColumns(nestedColumns: IMappedCollection): ApiInvoker;
+    setSorts(sorts: string[]): ApiInvoker;
+    setFirstRows(firstRows: number): this;
+    setOperRightCheck(check: boolean): this;
+    getFirstRows(): number;
+    addColumns(columns: string[]): ApiInvoker;
+    addAggregatedColumns(aggregatedColumns: IMappedCollection): ApiInvoker;
+    addNestedColumns(nestedColumns: IMappedCollection): ApiInvoker;
+    addFilters(filters: IFiltersCollection): ApiInvoker;
+    addAggregatedFilter(name: string, value: any): ApiInvoker;
+    addAggregatedFilters(filters: IFiltersCollection): ApiInvoker;
+    addSorts(sorts: string[]): ApiInvoker;
+    addFile(fileID: string, fileStream: any): ApiInvoker;
+    addRequestRow(data: Record<string, any>): ApiInvoker;
+    invoke(): ApiResponse;
+}
+
+type SourceTypeReport = {
+    sourceType: 'report';
+    config: jsWapi.JSWapiPdfLoadParamsReport['report'];
+};
+type SourceTypeObject = {
+    sourceType: 'object';
+    config: Omit<jsWapi.JSWapiPdfLoadParamsObject, 'callback'>;
+};
+type SourceTypeList = SourceTypeReport | SourceTypeObject;
+type SaveConfig = {
+    object: string;
+    keyValue: any;
+    field: string;
+    fileName: string;
+};
+type WaterMarkSourceType = SourceTypeList & {
+    position: ((sourcePdf: jsWapi.JSWapiPdfDocument, stampPdf: jsWapi.JSWapiPdfDocument) => jsWapi.JSWapiStampPosition) | jsWapi.JSWapiStampPosition;
+};
+type AddWatermarkToPdfParams = {
+    sourcePdf: SourceTypeList;
+    watermarks?: Array<WaterMarkSourceType>;
+    saveConfig: SaveConfig;
+};
+
+declare class ApiRequest {
+    private _jsWapiRequest;
+    private readonly _objectName;
+    constructor(jsWapiRequest: jsWapi.JSWapiRequest, objectName: string);
+    get objectName(): string;
+    get columns(): string[];
+    get aggregatedColumns(): IMappedCollection;
+    get nestedColumns(): IMappedCollection;
+    get filters(): IFiltersCollection;
+    get params(): IMappedCollection;
+    get request(): IMappedCollection | Array<IMappedCollection>;
+    get userId(): number;
+    get page(): number;
+    get rowsPerPage(): number;
+    get sorts(): string[];
+    get lang(): LanguageCode;
+    set columns(columns: string[]);
+    set aggregatedColumns(columns: IMappedCollection);
+    set nestedColumns(columns: IMappedCollection);
+    set filters(filters: IFiltersCollection);
+    set params(params: IMappedCollection);
+    set sorts(sorts: string[]);
+    set page(number: number);
+    set rowsPerPage(amount: number);
+    getFilter(filterName: string): any;
+    /**
+     * Вернуть значение фильтра типа "равно".
+     * Возможные варианты:
+     *     "поле": "значение"
+     *     "поле": {"=": "значение"}
+     *     "поле": ["значение"]
+     *     "поле": {"=": [123]}
+     * Это чтобы не парсить каждый раз все эти варианты.
+     *
+     * Работает только для условия "равно", для други возвращает null!!!!
+     */
+    getFilterValue(fieldName: string): any;
+    getParam(paramName: string): any;
+    getExcelFileAsJson(fileRequestId: string): any;
+    getFileAsString(fileRequestId: string): string;
+    getFilesListAsString(filesRequestIds: string[] | number[]): IMappedCollection;
+    getExcelFilesListAsJson(filesRequestIds: string[] | number[]): IMappedCollection;
+    getRequest(requestName: string): IMappedCollection[];
+    setHierarchy(parentColumn: string, requestKind?: number): this;
+    setColumns(columns: string[]): this;
+    setNestedColumns(nestedColumns: IMappedCollection): this;
+    setAggregatedColumns(aggregatedColumns: IMappedCollection): this;
+    getAggregatedFilter(name: string): any;
+    getAggregatedFilters(): any;
+    removeAggregatedFilter(name: string): this;
+    removeAggregatedFilters(names: string[]): this;
+    setFilters(filters: IFiltersCollection): ApiRequest;
+    setSorts(sorts: string[]): this;
+    setParams(params: IMappedCollection): ApiRequest;
+    setPage(number: number): ApiRequest;
+    setRowsPerPage(amount: number): ApiRequest;
+    setRequest(request: IMappedCollection | any[]): ApiRequest;
+    setFirstRows(firstRows: number): this;
+    getFirstRows(): number;
+    addSorts(sorts: string[]): ApiRequest;
+    addColumns(columns: string[]): ApiRequest;
+    addAggregatedColumns(columns: IMappedCollection): ApiRequest;
+    /**
+     * @link http://d5.develop.erp-director.com/userscript-docs/docs/server_scripts/api-request/api-request#addnestedcolumnscolumns
+     * @example
+     * apiRequest.addNestedColumns({
+     *     'AuthorsNested': {
+     *         'Columns': ['ID', 'Name']
+     *     }
+     * });
+     */
+    addNestedColumns(columns: IMappedCollection): ApiRequest;
+    addFilters(filters: IFiltersCollection): ApiRequest;
+    addAggregatedFilter(name: string, value: any): this;
+    addAggregatedFilters(filters: IFiltersCollection): this;
+    addParams(params: IMappedCollection): ApiRequest;
+    removeSorts(sortsNames: string[]): ApiRequest;
+    removeColumns(columnsNames: string[]): ApiRequest;
+    removeAggregatedColumns(aggregatedColumnsNames: string[]): ApiRequest;
+    removeNestedColumns(nestedColumnsNames: string[]): ApiRequest;
+    removeParams(paramsNames: string[]): ApiRequest;
+    removeFilters(filtersNames: string[]): ApiRequest;
+    hasFilter(filterName: string): boolean;
+    invoke(): ApiResponse;
+    newJSWapiInvoker(objectName: string, operName: string): jsWapi.JSWapiInvoker;
+    newApiInvoker(objectName: string, operName: string): ApiInvoker;
+    addWatermarkToPdf(params: AddWatermarkToPdfParams): void;
+    unzip(params: {
+        fileRequestId: string;
+        callback: (zipEntry: jsWapi.JSZipEntity) => void;
+    }): jsWapi.JSWapiPdf;
+    /**
+     * Вернуть содержимое meta-Excel в виде JSON-объекта:
+     * @param fileRequestId  имя поля в multipart-запросе с Excel-файлом
+     */
+    getMetaExcelFileAsJson(fileRequestId: string): Record<string, any>;
+    /**
+     * Переводит и форматирует строку из словаря переводов согласно текущего языка приложения.
+     * @param msgKey
+     * @param params
+     *
+     * @example
+     *  {
+     *    ...
+     *    "myKey": 'some text with {0}'
+     *    ...
+     *  }
+     *  t('myKey', ['placeholder text']) // 'some text with placeholder text'
+     */
+    t(msgKey: string, params?: string[]): string;
+    _getWithStringifiedElements(array: any[]): string[];
+}
+
+declare class ApiObjectCollectionIterator implements IInvoker$1<ApiObjectCollectionIterator> {
+    private _invoker;
+    private _rowsPerPage;
+    constructor({ invoker }: {
+        invoker: ApiInvoker;
+    });
+    get objectName(): string;
+    setColumns(columns: string[]): ApiObjectCollectionIterator;
+    setFilters(filters: IFiltersCollection): ApiObjectCollectionIterator;
+    setSorts(sorts: string[]): ApiObjectCollectionIterator;
+    addSorts(sorts: string[]): ApiObjectCollectionIterator;
+    addColumns(columns: string[]): ApiObjectCollectionIterator;
+    setRowsPerPage(amount: number): ApiObjectCollectionIterator;
+    invoke(): Generator<ApiResponse>;
+}
+
+interface IInvoker {
+    getExcelFileAsJson(): Map<string, any>;
+    getFileAsString(): string;
+    objectName: string;
+}
+interface IParams {
+    objectName: string;
+    keyValue: string | number;
+    fileFieldName: string;
+}
+declare class ApiFileInvoker implements IInvoker {
+    _jsWapiInvoker: jsWapi.JSWapiInvoker;
+    protected readonly _objectName: string;
+    constructor(jsWapiInvoker: jsWapi.JSWapiInvoker, params: IParams);
+    get objectName(): string;
+    setParams(keyValue: string | number, fileFieldName: string): void;
+    getExcelFileAsJson(): Map<string, any>;
+    getFileAsString(): string;
+}
+
+type HTTPSender = {
+    newJSWapiHttp(url: string): jsWapi.JSWapiHttp;
+    /** Если не валидируется, то будет exception. */
+    validateXml?(xsd: string, xml: string, options?: {
+        macroses: Record<string, any>;
+    }): boolean;
+};
+declare class ApiCore {
+    private readonly httpSender;
+    private readonly _request;
+    constructor({ http, request }: {
+        http: HTTPSender;
+        request: ApiRequest;
+    });
+    /**
+     * Переводит и форматирует строку из словаря переводов согласно текущего языка приложения.
+     * @param msgKey
+     * @param params
+     *
+     * @example
+     *  {
+     *    ...
+     *    "myKey": 'some text with {0}'
+     *    ...
+     *  }
+     *  t('myKey', ['placeholder text']) // 'some text with placeholder text'
+     */
+    t(msgKey: string, params?: string[]): string;
+    newHttpRequest(url: string): ApiHttpRequest;
+    newApiInvoker(objectName: string, operName: string): ApiInvoker;
+    newApiFileInvoker(objectName: string, keyValue: string | number, fileFieldName: string): ApiFileInvoker;
+    newApiObjectCollectionIterator(objectName: string): ApiObjectCollectionIterator;
+    newApiException(message: string, code?: string | number): Error;
+    /**
+     * Валидирует xml по переданому xsd.
+     * Если валидация происходит с ошибками, то бросается исключение.
+     */
+    validateXml(xml: string, xsd: string, options?: {
+        macroses: Record<string, any>;
+    }): boolean;
+}
+
+declare class ApiHttpResponse {
+    private readonly _jsWapiHttpResponse;
+    constructor(jsWapiHttpResponse: jsWapi.JSWapiHttpResponse);
+    get statusCode(): number;
+    get body(): string;
+    get bodyAsStream(): jsWapi.BinaryDataStream;
+    getHeader(name: string): string;
+    isSuccessful(): boolean;
+}
+
+interface IFilterValue {
+    '='?: string | number | null | Array<string | number>;
+    '=~'?: string | null | Array<string>;
+    '>'?: string | number;
+    '>='?: string | number;
+    '<'?: string | number;
+    '<='?: string | number;
+    '!='?: string | number | null | Array<string | number>;
+    '<>'?: string | number | null | Array<string | number>;
+    'between'?: [string | number, string | number];
+    'like'?: string | number;
+    '%'?: string;
+    '%~'?: string;
+}
+interface IFilter {
+    [fieldName: string]: IFilterValue;
+}
+type IFiltersCollection = {
+    [fieldName: string]: IFilterValue | IFilterValue[] | IFiltersCollection[];
+};
+interface IMappedCollection {
+    [name: string]: any;
+}
+type IApiOperation<MetaParams> = (apiCore: ApiCore, apiRequest: ApiRequest, apiResponse: ApiResponse, meta?: jsWapi.JSWapiMeta<MetaParams>) => void;
+interface IApiOperations<MetaParams = Record<string, any>> {
+    [key: string]: IApiOperation<MetaParams>;
+}
+type IHttpCallback = (apiHttpResponse: ApiHttpResponse) => any | void;
+declare enum LanguageCode {
+    ua = "ua",
+    ru = "ru",
+    en = "eng"
+}
+
+interface ApiObjectInitializerConstructor {
+    objectName: string;
+    operations: IApiOperations;
+    translations?: Record<LanguageCode, Record<string, string>>;
+}
+declare abstract class ApiInitializer<MetaParams> {
+    protected _api: typeof jsWapi;
+    protected _operations: IApiOperations<MetaParams>;
+    constructor(settings: ApiObjectInitializerConstructor);
+    constructor(objectName: string, operations: IApiOperations<MetaParams>);
+    constructor(objectName: string, operations: IApiOperations<MetaParams>, options: Pick<ApiObjectInitializerConstructor, 'translations'>);
+    protected _initOperations(objectName?: string): void;
+    protected abstract internalCreate(objectName: string): void;
+    protected abstract putOperation(operationName: string, objectName?: string): void;
+    /**
+     * Инициализация словаря переводов.
+     * @param translations
+     * @example Пример строки перевода
+     * { ...
+     *  "ru": {"key": 'some text {0} {1}'}
+     *   ...
+     * }
+     *
+     *  core.t('key', ['test1', 'test2']); // 'some text test1 test2'
+     */
+    initTranslation(translations: Record<LanguageCode, Record<string, string>>): void;
+}
+declare class ApiObjectInitializer<MetaParams = undefined> extends ApiInitializer<MetaParams> {
+    private jsWapiObject;
+    protected internalCreate(objectName: string): void;
+    protected putOperation(operationName: string, objectName?: string): void;
+}
+
+declare class EngineInitializer<MetaParams = Record<string, any>> {
+    private engine;
+    protected _operations: IApiOperations<MetaParams>;
+    constructor(options: Omit<ApiObjectInitializerConstructor, 'objectName'>);
+    constructor(operations: IApiOperations<MetaParams>);
+    constructor(operations: IApiOperations<MetaParams>, options: Pick<ApiObjectInitializerConstructor, 'translations'>);
+    private internalCreate;
+    private putOperation;
+    /**
+     * Инициализация словаря переводов.
+     * @param translations
+     * @example Пример строки перевода
+     * { ...
+     *  "ru": {"key": 'some text {0} {1}'}
+     *   ...
+     * }
+     *
+     *  core.t('key', ['test1', 'test2']); // 'some text test1 test2'
+     */
+    initTranslation(translations: Record<LanguageCode, Record<string, string>>): void;
+    call({ apiCore, apiRequest, apiResponse, operation, meta }: {
+        apiCore: ApiCore;
+        apiRequest: ApiRequest;
+        apiResponse: ApiResponse;
+        operation: string;
+        meta: jsWapi.JSWapiMeta<MetaParams>;
+    }): void;
+}
+
+declare class ApplicationInitializer<MetaParams = undefined> {
+    private jSWapiApplication;
+    protected _operations: IApiOperations<MetaParams>;
+    constructor(operations: IApiOperations<MetaParams>);
+    private internalCreate;
+    private putOperation;
+}
+
+declare class ApiJoinInvoker {
+    readonly _jsWapiJoinInvoker: any;
+    constructor(jsWapiJoinInvoker: any);
+}
+
+declare class UserMessages {
+    private _messages;
+    private _lang;
+    appendDictionary(newDictionary: Record<LanguageCode, Record<string, string>>): void;
+    format(msgKey: string, params?: string[]): string;
+    set lang(value: LanguageCode);
+}
+declare const _default: UserMessages;
+
+export { ApiCore, ApiHttpRequest, ApiHttpResponse, ApiInvoker, ApiJoinInvoker, ApiObjectCollectionIterator, ApiRequest, ApiResponse, ApplicationInitializer, EngineInitializer, type IApiOperations, type IFilter, type IFilterValue, type IFiltersCollection, type IHttpCallback, type IMappedCollection, LanguageCode, MultipartFormData, _default as UserMessages, ApiObjectInitializer as default, fileLink, fileRequestId };