@itwin/core-mobile 4.0.0-dev.8 → 4.0.0-dev.81

package/lib/cjs/backend/MobileRpcServer.js

@@ -1,157 +1,157 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setupMobileRpc = exports.MobileRpcServer = void 0;
-const ws = require("ws");
-const core_common_1 = require("@itwin/core-common");
-const MobileRpcProtocol_1 = require("../common/MobileRpcProtocol");
-const MobileRpcManager_1 = require("../common/MobileRpcManager");
-const MobileHost_1 = require("./MobileHost");
-const core_bentley_1 = require("@itwin/core-bentley");
-let addon;
-/** @internal */
-class MobileRpcServer {
-    constructor() {
-        /* _pingTime is a fix for ios/mobile case where when the app moves into foreground from
-         * background backend restart ws.Server and then notify frontend to reconnect. But ws.Server
-         * listening event is not fired as node yield to kevent and wait for some io event to happen.
-         * This causes a delay in reconnection which may be as long a 40 secs. To solve the issue we
-         * create _pingTimer which causes kevent to yield back to uv poll so timer event can be fired.
-         * This allow listening event to go through quickly (max 5ms). Once the listening event occur we
-         * clear the timer. Here we use setInterval() just to make sure otherwise setTimeout() could equally
-         * be effective
-         */
-        this._pingTimer = setInterval(() => { }, 5);
-        this._port = MobileRpcManager_1.MobileRpcConfiguration.setup.obtainPort();
-        this._server = new ws.Server({ port: this._port });
-        this._connectionId = ++MobileRpcServer._nextId;
-        MobileRpcServer.interop.connectionId = this._connectionId;
-        this._onListening();
-        this._onConnection();
-    }
-    _onListening() {
-        this._server.on("listening", () => {
-            const address = this._server.address();
-            this._port = address.port;
-            clearInterval(this._pingTimer);
-            this._notifyListening();
-        });
-    }
-    _notifyListening() {
-        MobileRpcServer.interop.port = this._port;
-        if (addon) {
-            addon.notifyListening(this._port);
-        }
-        if (this._connectionId !== 0) {
-            MobileHost_1.MobileHost.reconnect(this._port);
-        }
-    }
-    _onConnection() {
-        this._server.on("connection", (connection) => {
-            this._connection = connection;
-            this._connection.on("message", (data) => this._onConnectionMessage(data));
-            this._createSender();
-            global.__iTwinJsRpcReady = true;
-        });
-    }
-    _createSender() {
-        const sender = (message, connectionId) => {
-            if (connectionId !== this._connectionId) {
-                return;
-            }
-            this._connection.send(message, (err) => {
-                if (err) {
-                    throw err;
-                }
-            });
-        };
-        MobileRpcServer.interop.sendString = sender;
-        MobileRpcServer.interop.sendBinary = sender;
-    }
-    _onConnectionMessage(data) {
-        let message = data;
-        if (Array.isArray(message)) {
-            throw new core_common_1.IModelError(core_common_1.BentleyStatus.ERROR, "Unsupported data type");
-        }
-        if (Buffer.isBuffer(message)) {
-            if (message.byteOffset !== 0 || message.byteLength !== message.buffer.byteLength) {
-                message = new Uint8Array(message.buffer, message.byteOffset, message.byteLength);
-            }
-            else {
-                message = message.buffer;
-            }
-        }
-        MobileRpcServer.interop.handler(message, this._connectionId);
-    }
-    dispose() {
-        clearInterval(this._pingTimer);
-        if (this._connection) {
-            MobileRpcServer.interop.sendString = () => { };
-            MobileRpcServer.interop.sendBinary = () => { };
-            this._connection.close();
-        }
-        this._server.close();
-    }
-}
-exports.MobileRpcServer = MobileRpcServer;
-MobileRpcServer._nextId = -1;
-MobileRpcServer.interop = {
-    handler: (_payload) => { throw new core_common_1.IModelError(core_common_1.BentleyStatus.ERROR, "Not implemented."); },
-    sendString: (_message, _connectionId) => { throw new core_common_1.IModelError(core_common_1.BentleyStatus.ERROR, "No connection."); },
-    sendBinary: (_message, _connectionId) => { throw new core_common_1.IModelError(core_common_1.BentleyStatus.ERROR, "No connection."); },
-    port: 0,
-    connectionId: 0,
-};
-let mobileReady = false;
-let hasSuspended = false;
-function setupMobileRpc() {
-    if (mobileReady) {
-        return;
-    }
-    if (core_bentley_1.ProcessDetector.isMobileAppBackend) {
-        addon = process._linkedBinding("iModelJsMobile");
-        addon === null || addon === void 0 ? void 0 : addon.registerDeviceImpl();
-    }
-    let server = new MobileRpcServer();
-    /* The UV event loop (internal to node) is retained by handles,
-       such as those created for setInterval/setTimeout and client/server connections.
-       In a simple app, the RPC server may be the only handle retaining the UV loop.
-       Thus, we install a temporary timer on suspend to prevent the loop from exiting prematurely.
-    */
-    let retainUvLoop;
-    MobileHost_1.MobileHost.onEnterBackground.addListener(() => {
-        hasSuspended = true;
-        if (server === null) {
-            return;
-        }
-        retainUvLoop = setInterval(() => { }, 1000);
-        server.dispose();
-        server = null;
-    });
-    MobileHost_1.MobileHost.onEnterForeground.addListener(() => {
-        if (!hasSuspended) {
-            return;
-        }
-        server = new MobileRpcServer();
-        clearInterval(retainUvLoop);
-        retainUvLoop = undefined;
-    });
-    MobileHost_1.MobileHost.onWillTerminate.addListener(() => {
-        if (typeof (retainUvLoop) !== "undefined") {
-            clearInterval(retainUvLoop);
-            retainUvLoop = undefined;
-        }
-        if (server === null) {
-            return;
-        }
-        server.dispose();
-        server = null;
-    });
-    MobileRpcProtocol_1.MobileRpcProtocol.obtainInterop = () => MobileRpcServer.interop;
-    mobileReady = true;
-}
-exports.setupMobileRpc = setupMobileRpc;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupMobileRpc = exports.MobileRpcServer = void 0;
+const ws = require("ws");
+const core_common_1 = require("@itwin/core-common");
+const MobileRpcProtocol_1 = require("../common/MobileRpcProtocol");
+const MobileRpcManager_1 = require("../common/MobileRpcManager");
+const MobileHost_1 = require("./MobileHost");
+const core_bentley_1 = require("@itwin/core-bentley");
+let addon;
+/** @internal */
+class MobileRpcServer {
+    constructor() {
+        /* _pingTime is a fix for ios/mobile case where when the app moves into foreground from
+         * background backend restart ws.Server and then notify frontend to reconnect. But ws.Server
+         * listening event is not fired as node yield to kevent and wait for some io event to happen.
+         * This causes a delay in reconnection which may be as long a 40 secs. To solve the issue we
+         * create _pingTimer which causes kevent to yield back to uv poll so timer event can be fired.
+         * This allow listening event to go through quickly (max 5ms). Once the listening event occur we
+         * clear the timer. Here we use setInterval() just to make sure otherwise setTimeout() could equally
+         * be effective
+         */
+        this._pingTimer = setInterval(() => { }, 5);
+        this._port = MobileRpcManager_1.MobileRpcConfiguration.setup.obtainPort();
+        this._server = new ws.Server({ port: this._port });
+        this._connectionId = ++MobileRpcServer._nextId;
+        MobileRpcServer.interop.connectionId = this._connectionId;
+        this._onListening();
+        this._onConnection();
+    }
+    _onListening() {
+        this._server.on("listening", () => {
+            const address = this._server.address();
+            this._port = address.port;
+            clearInterval(this._pingTimer);
+            this._notifyListening();
+        });
+    }
+    _notifyListening() {
+        MobileRpcServer.interop.port = this._port;
+        if (addon) {
+            addon.notifyListening(this._port);
+        }
+        if (this._connectionId !== 0) {
+            MobileHost_1.MobileHost.reconnect(this._port);
+        }
+    }
+    _onConnection() {
+        this._server.on("connection", (connection) => {
+            this._connection = connection;
+            this._connection.on("message", (data) => this._onConnectionMessage(data));
+            this._createSender();
+            global.__iTwinJsRpcReady = true;
+        });
+    }
+    _createSender() {
+        const sender = (message, connectionId) => {
+            if (connectionId !== this._connectionId) {
+                return;
+            }
+            this._connection.send(message, (err) => {
+                if (err) {
+                    throw err;
+                }
+            });
+        };
+        MobileRpcServer.interop.sendString = sender;
+        MobileRpcServer.interop.sendBinary = sender;
+    }
+    _onConnectionMessage(data) {
+        let message = data;
+        if (Array.isArray(message)) {
+            throw new core_common_1.IModelError(core_common_1.BentleyStatus.ERROR, "Unsupported data type");
+        }
+        if (Buffer.isBuffer(message)) {
+            if (message.byteOffset !== 0 || message.byteLength !== message.buffer.byteLength) {
+                message = new Uint8Array(message.buffer, message.byteOffset, message.byteLength);
+            }
+            else {
+                message = message.buffer;
+            }
+        }
+        MobileRpcServer.interop.handler(message, this._connectionId);
+    }
+    dispose() {
+        clearInterval(this._pingTimer);
+        if (this._connection) {
+            MobileRpcServer.interop.sendString = () => { };
+            MobileRpcServer.interop.sendBinary = () => { };
+            this._connection.close();
+        }
+        this._server.close();
+    }
+}
+MobileRpcServer._nextId = -1;
+MobileRpcServer.interop = {
+    handler: (_payload) => { throw new core_common_1.IModelError(core_common_1.BentleyStatus.ERROR, "Not implemented."); },
+    sendString: (_message, _connectionId) => { throw new core_common_1.IModelError(core_common_1.BentleyStatus.ERROR, "No connection."); },
+    sendBinary: (_message, _connectionId) => { throw new core_common_1.IModelError(core_common_1.BentleyStatus.ERROR, "No connection."); },
+    port: 0,
+    connectionId: 0,
+};
+exports.MobileRpcServer = MobileRpcServer;
+let mobileReady = false;
+let hasSuspended = false;
+function setupMobileRpc() {
+    if (mobileReady) {
+        return;
+    }
+    if (core_bentley_1.ProcessDetector.isMobileAppBackend) {
+        addon = process._linkedBinding("iModelJsMobile");
+        addon?.registerDeviceImpl();
+    }
+    let server = new MobileRpcServer();
+    /* The UV event loop (internal to node) is retained by handles,
+       such as those created for setInterval/setTimeout and client/server connections.
+       In a simple app, the RPC server may be the only handle retaining the UV loop.
+       Thus, we install a temporary timer on suspend to prevent the loop from exiting prematurely.
+    */
+    let retainUvLoop;
+    MobileHost_1.MobileHost.onEnterBackground.addListener(() => {
+        hasSuspended = true;
+        if (server === null) {
+            return;
+        }
+        retainUvLoop = setInterval(() => { }, 1000);
+        server.dispose();
+        server = null;
+    });
+    MobileHost_1.MobileHost.onEnterForeground.addListener(() => {
+        if (!hasSuspended) {
+            return;
+        }
+        server = new MobileRpcServer();
+        clearInterval(retainUvLoop);
+        retainUvLoop = undefined;
+    });
+    MobileHost_1.MobileHost.onWillTerminate.addListener(() => {
+        if (typeof (retainUvLoop) !== "undefined") {
+            clearInterval(retainUvLoop);
+            retainUvLoop = undefined;
+        }
+        if (server === null) {
+            return;
+        }
+        server.dispose();
+        server = null;
+    });
+    MobileRpcProtocol_1.MobileRpcProtocol.obtainInterop = () => MobileRpcServer.interop;
+    mobileReady = true;
+}
+exports.setupMobileRpc = setupMobileRpc;
 //# sourceMappingURL=MobileRpcServer.js.map

package/lib/cjs/backend/MobileRpcServer.js.map

@@ -1 +1 @@
-{"version":3,"file":"MobileRpcServer.js","sourceRoot":"","sources":["../../../src/backend/MobileRpcServer.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,yBAAyB;AACzB,oDAAgE;AAChE,mEAAkF;AAClF,iEAAoE;AACpE,6CAA0C;AAC1C,sDAAsD;AAStD,IAAI,KAA8B,CAAC;AAEnC,gBAAgB;AAChB,MAAa,eAAe;IAgB1B;QACE;;;;;;;;WAQG;QACH,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QAC5C,IAAI,CAAC,KAAK,GAAG,yCAAsB,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;QACvD,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QACnD,IAAI,CAAC,aAAa,GAAG,EAAE,eAAe,CAAC,OAAO,CAAC;QAC/C,eAAe,CAAC,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC;QAC1D,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEO,YAAY;QAClB,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;YAChC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAoB,CAAC;YACzD,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;YAC1B,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC/B,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,gBAAgB;QACtB,eAAe,CAAC,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;QAE1C,IAAI,KAAK,EAAE;YACT,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACnC;QAED,IAAI,IAAI,CAAC,aAAa,KAAK,CAAC,EAAE;YAC5B,uBAAU,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SAClC;IACH,CAAC;IAEO,aAAa;QACnB,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,EAAE;YAC3C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;YAC9B,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC;YAC1E,IAAI,CAAC,aAAa,EAAE,CAAC;YACpB,MAAc,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,aAAa;QACnB,MAAM,MAAM,GAAG,CAAC,OAA4B,EAAE,YAAoB,EAAE,EAAE;YACpE,IAAI,YAAY,KAAK,IAAI,CAAC,aAAa,EAAE;gBACvC,OAAO;aACR;YAED,IAAI,CAAC,WAAY,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;gBACtC,IAAI,GAAG,EAAE;oBACP,MAAM,GAAG,CAAC;iBACX;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,eAAe,CAAC,OAAO,CAAC,UAAU,GAAG,MAAM,CAAC;QAC5C,eAAe,CAAC,OAAO,CAAC,UAAU,GAAG,MAAM,CAAC;IAC9C,CAAC;IAEO,oBAAoB,CAAC,IAAa;QACxC,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YAC1B,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,uBAAuB,CAAC,CAAC;SACrE;QAED,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC5B,IAAI,OAAO,CAAC,UAAU,KAAK,CAAC,IAAI,OAAO,CAAC,UAAU,KAAK,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE;gBAChF,OAAO,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;aAClF;iBAAM;gBACL,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;aAC1B;SACF;QAED,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IAC/D,CAAC;IAEM,OAAO;QACZ,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/B,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,eAAe,CAAC,OAAO,CAAC,UAAU,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;YAC/C,eAAe,CAAC,OAAO,CAAC,UAAU,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;YAC/C,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;SAC1B;QAED,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;;AA5GH,0CA6GC;AA5GgB,uBAAO,GAAG,CAAC,CAAC,CAAC;AAEd,uBAAO,GAAqB;IACxC,OAAO,EAAE,CAAC,QAA8B,EAAE,EAAE,GAAG,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAChH,UAAU,EAAE,CAAC,QAAgB,EAAE,aAAqB,EAAE,EAAE,GAAG,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAC1H,UAAU,EAAE,CAAC,QAAoB,EAAE,aAAqB,EAAE,EAAE,GAAG,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAC9H,IAAI,EAAE,CAAC;IACP,YAAY,EAAE,CAAC;CAChB,CAAC;AAsGJ,IAAI,WAAW,GAAG,KAAK,CAAC;AACxB,IAAI,YAAY,GAAG,KAAK,CAAC;AAEzB,SAAgB,cAAc;IAC5B,IAAI,WAAW,EAAE;QACf,OAAO;KACR;IAED,IAAI,8BAAe,CAAC,kBAAkB,EAAE;QACtC,KAAK,GAAI,OAAe,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;QAC1D,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,kBAAkB,EAAE,CAAC;KAC7B;IAED,IAAI,MAAM,GAA2B,IAAI,eAAe,EAAE,CAAC;IAE3D;;;;MAIE;IACF,IAAI,YAAsC,CAAC;IAE3C,uBAAU,CAAC,iBAAiB,CAAC,WAAW,CAAC,GAAG,EAAE;QAC5C,YAAY,GAAG,IAAI,CAAC;QAEpB,IAAI,MAAM,KAAK,IAAI,EAAE;YACnB,OAAO;SACR;QAED,YAAY,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;QAC5C,MAAM,CAAC,OAAO,EAAE,CAAC;QACjB,MAAM,GAAG,IAAI,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,uBAAU,CAAC,iBAAiB,CAAC,WAAW,CAAC,GAAG,EAAE;QAC5C,IAAI,CAAC,YAAY,EAAE;YACjB,OAAO;SACR;QAED,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QAC/B,aAAa,CAAC,YAAY,CAAC,CAAC;QAC5B,YAAY,GAAG,SAAS,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,uBAAU,CAAC,eAAe,CAAC,WAAW,CAAC,GAAG,EAAE;QAC1C,IAAI,OAAO,CAAC,YAAY,CAAC,KAAK,WAAW,EAAE;YACzC,aAAa,CAAC,YAAY,CAAC,CAAC;YAC5B,YAAY,GAAG,SAAS,CAAC;SAC1B;QAED,IAAI,MAAM,KAAK,IAAI,EAAE;YACnB,OAAO;SACR;QAED,MAAM,CAAC,OAAO,EAAE,CAAC;QACjB,MAAM,GAAG,IAAI,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,qCAAiB,CAAC,aAAa,GAAG,GAAG,EAAE,CAAC,eAAe,CAAC,OAAO,CAAC;IAChE,WAAW,GAAG,IAAI,CAAC;AACrB,CAAC;AAzDD,wCAyDC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport * as ws from \"ws\";\r\nimport { BentleyStatus, IModelError } from \"@itwin/core-common\";\r\nimport { MobileRpcGateway, MobileRpcProtocol } from \"../common/MobileRpcProtocol\";\r\nimport { MobileRpcConfiguration } from \"../common/MobileRpcManager\";\r\nimport { MobileHost } from \"./MobileHost\";\r\nimport { ProcessDetector } from \"@itwin/core-bentley\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\ninterface MobileAddon {\r\n  notifyListening: (port: number) => void;\r\n  registerDeviceImpl: () => void;\r\n}\r\n\r\nlet addon: MobileAddon | undefined;\r\n\r\n/** @internal */\r\nexport class MobileRpcServer {\r\n  private static _nextId = -1;\r\n\r\n  public static interop: MobileRpcGateway = {\r\n    handler: (_payload: ArrayBuffer | string) => { throw new IModelError(BentleyStatus.ERROR, \"Not implemented.\"); },\r\n    sendString: (_message: string, _connectionId: number) => { throw new IModelError(BentleyStatus.ERROR, \"No connection.\"); },\r\n    sendBinary: (_message: Uint8Array, _connectionId: number) => { throw new IModelError(BentleyStatus.ERROR, \"No connection.\"); },\r\n    port: 0,\r\n    connectionId: 0,\r\n  };\r\n\r\n  private _server: ws.Server;\r\n  private _connection: ws | undefined;\r\n  private _port: number;\r\n  private _connectionId: number;\r\n  private _pingTimer: NodeJS.Timeout;\r\n  public constructor() {\r\n    /* _pingTime is a fix for ios/mobile case where when the app moves into foreground from\r\n     * background backend restart ws.Server and then notify frontend to reconnect. But ws.Server\r\n     * listening event is not fired as node yield to kevent and wait for some io event to happen.\r\n     * This causes a delay in reconnection which may be as long a 40 secs. To solve the issue we\r\n     * create _pingTimer which causes kevent to yield back to uv poll so timer event can be fired.\r\n     * This allow listening event to go through quickly (max 5ms). Once the listening event occur we\r\n     * clear the timer. Here we use setInterval() just to make sure otherwise setTimeout() could equally\r\n     * be effective\r\n     */\r\n    this._pingTimer = setInterval(() => { }, 5);\r\n    this._port = MobileRpcConfiguration.setup.obtainPort();\r\n    this._server = new ws.Server({ port: this._port });\r\n    this._connectionId = ++MobileRpcServer._nextId;\r\n    MobileRpcServer.interop.connectionId = this._connectionId;\r\n    this._onListening();\r\n    this._onConnection();\r\n  }\r\n\r\n  private _onListening() {\r\n    this._server.on(\"listening\", () => {\r\n      const address = this._server.address() as ws.AddressInfo;\r\n      this._port = address.port;\r\n      clearInterval(this._pingTimer);\r\n      this._notifyListening();\r\n    });\r\n  }\r\n\r\n  private _notifyListening() {\r\n    MobileRpcServer.interop.port = this._port;\r\n\r\n    if (addon) {\r\n      addon.notifyListening(this._port);\r\n    }\r\n\r\n    if (this._connectionId !== 0) {\r\n      MobileHost.reconnect(this._port);\r\n    }\r\n  }\r\n\r\n  private _onConnection() {\r\n    this._server.on(\"connection\", (connection) => {\r\n      this._connection = connection;\r\n      this._connection.on(\"message\", (data) => this._onConnectionMessage(data));\r\n      this._createSender();\r\n      (global as any).__iTwinJsRpcReady = true;\r\n    });\r\n  }\r\n\r\n  private _createSender() {\r\n    const sender = (message: string | Uint8Array, connectionId: number) => {\r\n      if (connectionId !== this._connectionId) {\r\n        return;\r\n      }\r\n\r\n      this._connection!.send(message, (err) => {\r\n        if (err) {\r\n          throw err;\r\n        }\r\n      });\r\n    };\r\n\r\n    MobileRpcServer.interop.sendString = sender;\r\n    MobileRpcServer.interop.sendBinary = sender;\r\n  }\r\n\r\n  private _onConnectionMessage(data: ws.Data) {\r\n    let message = data;\r\n    if (Array.isArray(message)) {\r\n      throw new IModelError(BentleyStatus.ERROR, \"Unsupported data type\");\r\n    }\r\n\r\n    if (Buffer.isBuffer(message)) {\r\n      if (message.byteOffset !== 0 || message.byteLength !== message.buffer.byteLength) {\r\n        message = new Uint8Array(message.buffer, message.byteOffset, message.byteLength);\r\n      } else {\r\n        message = message.buffer;\r\n      }\r\n    }\r\n\r\n    MobileRpcServer.interop.handler(message, this._connectionId);\r\n  }\r\n\r\n  public dispose() {\r\n    clearInterval(this._pingTimer);\r\n    if (this._connection) {\r\n      MobileRpcServer.interop.sendString = () => { };\r\n      MobileRpcServer.interop.sendBinary = () => { };\r\n      this._connection.close();\r\n    }\r\n\r\n    this._server.close();\r\n  }\r\n}\r\n\r\nlet mobileReady = false;\r\nlet hasSuspended = false;\r\n\r\nexport function setupMobileRpc() {\r\n  if (mobileReady) {\r\n    return;\r\n  }\r\n\r\n  if (ProcessDetector.isMobileAppBackend) {\r\n    addon = (process as any)._linkedBinding(\"iModelJsMobile\");\r\n    addon?.registerDeviceImpl();\r\n  }\r\n\r\n  let server: MobileRpcServer | null = new MobileRpcServer();\r\n\r\n  /* The UV event loop (internal to node) is retained by handles,\r\n     such as those created for setInterval/setTimeout and client/server connections.\r\n     In a simple app, the RPC server may be the only handle retaining the UV loop.\r\n     Thus, we install a temporary timer on suspend to prevent the loop from exiting prematurely.\r\n  */\r\n  let retainUvLoop: NodeJS.Timer | undefined;\r\n\r\n  MobileHost.onEnterBackground.addListener(() => {\r\n    hasSuspended = true;\r\n\r\n    if (server === null) {\r\n      return;\r\n    }\r\n\r\n    retainUvLoop = setInterval(() => { }, 1000);\r\n    server.dispose();\r\n    server = null;\r\n  });\r\n\r\n  MobileHost.onEnterForeground.addListener(() => {\r\n    if (!hasSuspended) {\r\n      return;\r\n    }\r\n\r\n    server = new MobileRpcServer();\r\n    clearInterval(retainUvLoop);\r\n    retainUvLoop = undefined;\r\n  });\r\n\r\n  MobileHost.onWillTerminate.addListener(() => {\r\n    if (typeof (retainUvLoop) !== \"undefined\") {\r\n      clearInterval(retainUvLoop);\r\n      retainUvLoop = undefined;\r\n    }\r\n\r\n    if (server === null) {\r\n      return;\r\n    }\r\n\r\n    server.dispose();\r\n    server = null;\r\n  });\r\n\r\n  MobileRpcProtocol.obtainInterop = () => MobileRpcServer.interop;\r\n  mobileReady = true;\r\n}\r\n"]}
+{"version":3,"file":"MobileRpcServer.js","sourceRoot":"","sources":["../../../src/backend/MobileRpcServer.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,yBAAyB;AACzB,oDAAgE;AAChE,mEAAkF;AAClF,iEAAoE;AACpE,6CAA0C;AAC1C,sDAAsD;AAStD,IAAI,KAA8B,CAAC;AAEnC,gBAAgB;AAChB,MAAa,eAAe;IAgB1B;QACE;;;;;;;;WAQG;QACH,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QAC5C,IAAI,CAAC,KAAK,GAAG,yCAAsB,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;QACvD,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QACnD,IAAI,CAAC,aAAa,GAAG,EAAE,eAAe,CAAC,OAAO,CAAC;QAC/C,eAAe,CAAC,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC;QAC1D,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEO,YAAY;QAClB,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;YAChC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAoB,CAAC;YACzD,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;YAC1B,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC/B,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,gBAAgB;QACtB,eAAe,CAAC,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;QAE1C,IAAI,KAAK,EAAE;YACT,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACnC;QAED,IAAI,IAAI,CAAC,aAAa,KAAK,CAAC,EAAE;YAC5B,uBAAU,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SAClC;IACH,CAAC;IAEO,aAAa;QACnB,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,EAAE;YAC3C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;YAC9B,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC;YAC1E,IAAI,CAAC,aAAa,EAAE,CAAC;YACpB,MAAc,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,aAAa;QACnB,MAAM,MAAM,GAAG,CAAC,OAA4B,EAAE,YAAoB,EAAE,EAAE;YACpE,IAAI,YAAY,KAAK,IAAI,CAAC,aAAa,EAAE;gBACvC,OAAO;aACR;YAED,IAAI,CAAC,WAAY,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;gBACtC,IAAI,GAAG,EAAE;oBACP,MAAM,GAAG,CAAC;iBACX;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,eAAe,CAAC,OAAO,CAAC,UAAU,GAAG,MAAM,CAAC;QAC5C,eAAe,CAAC,OAAO,CAAC,UAAU,GAAG,MAAM,CAAC;IAC9C,CAAC;IAEO,oBAAoB,CAAC,IAAa;QACxC,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YAC1B,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,uBAAuB,CAAC,CAAC;SACrE;QAED,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC5B,IAAI,OAAO,CAAC,UAAU,KAAK,CAAC,IAAI,OAAO,CAAC,UAAU,KAAK,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE;gBAChF,OAAO,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;aAClF;iBAAM;gBACL,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;aAC1B;SACF;QAED,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IAC/D,CAAC;IAEM,OAAO;QACZ,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/B,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,eAAe,CAAC,OAAO,CAAC,UAAU,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;YAC/C,eAAe,CAAC,OAAO,CAAC,UAAU,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;YAC/C,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;SAC1B;QAED,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;;AA3Gc,uBAAO,GAAG,CAAC,CAAC,CAAC;AAEd,uBAAO,GAAqB;IACxC,OAAO,EAAE,CAAC,QAA8B,EAAE,EAAE,GAAG,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAChH,UAAU,EAAE,CAAC,QAAgB,EAAE,aAAqB,EAAE,EAAE,GAAG,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAC1H,UAAU,EAAE,CAAC,QAAoB,EAAE,aAAqB,EAAE,EAAE,GAAG,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAC9H,IAAI,EAAE,CAAC;IACP,YAAY,EAAE,CAAC;CAChB,CAAC;AATS,0CAAe;AA+G5B,IAAI,WAAW,GAAG,KAAK,CAAC;AACxB,IAAI,YAAY,GAAG,KAAK,CAAC;AAEzB,SAAgB,cAAc;IAC5B,IAAI,WAAW,EAAE;QACf,OAAO;KACR;IAED,IAAI,8BAAe,CAAC,kBAAkB,EAAE;QACtC,KAAK,GAAI,OAAe,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;QAC1D,KAAK,EAAE,kBAAkB,EAAE,CAAC;KAC7B;IAED,IAAI,MAAM,GAA2B,IAAI,eAAe,EAAE,CAAC;IAE3D;;;;MAIE;IACF,IAAI,YAAsC,CAAC;IAE3C,uBAAU,CAAC,iBAAiB,CAAC,WAAW,CAAC,GAAG,EAAE;QAC5C,YAAY,GAAG,IAAI,CAAC;QAEpB,IAAI,MAAM,KAAK,IAAI,EAAE;YACnB,OAAO;SACR;QAED,YAAY,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;QAC5C,MAAM,CAAC,OAAO,EAAE,CAAC;QACjB,MAAM,GAAG,IAAI,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,uBAAU,CAAC,iBAAiB,CAAC,WAAW,CAAC,GAAG,EAAE;QAC5C,IAAI,CAAC,YAAY,EAAE;YACjB,OAAO;SACR;QAED,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QAC/B,aAAa,CAAC,YAAY,CAAC,CAAC;QAC5B,YAAY,GAAG,SAAS,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,uBAAU,CAAC,eAAe,CAAC,WAAW,CAAC,GAAG,EAAE;QAC1C,IAAI,OAAO,CAAC,YAAY,CAAC,KAAK,WAAW,EAAE;YACzC,aAAa,CAAC,YAAY,CAAC,CAAC;YAC5B,YAAY,GAAG,SAAS,CAAC;SAC1B;QAED,IAAI,MAAM,KAAK,IAAI,EAAE;YACnB,OAAO;SACR;QAED,MAAM,CAAC,OAAO,EAAE,CAAC;QACjB,MAAM,GAAG,IAAI,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,qCAAiB,CAAC,aAAa,GAAG,GAAG,EAAE,CAAC,eAAe,CAAC,OAAO,CAAC;IAChE,WAAW,GAAG,IAAI,CAAC;AACrB,CAAC;AAzDD,wCAyDC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nimport * as ws from \"ws\";\nimport { BentleyStatus, IModelError } from \"@itwin/core-common\";\nimport { MobileRpcGateway, MobileRpcProtocol } from \"../common/MobileRpcProtocol\";\nimport { MobileRpcConfiguration } from \"../common/MobileRpcManager\";\nimport { MobileHost } from \"./MobileHost\";\nimport { ProcessDetector } from \"@itwin/core-bentley\";\n\n/* eslint-disable deprecation/deprecation */\n\ninterface MobileAddon {\n  notifyListening: (port: number) => void;\n  registerDeviceImpl: () => void;\n}\n\nlet addon: MobileAddon | undefined;\n\n/** @internal */\nexport class MobileRpcServer {\n  private static _nextId = -1;\n\n  public static interop: MobileRpcGateway = {\n    handler: (_payload: ArrayBuffer | string) => { throw new IModelError(BentleyStatus.ERROR, \"Not implemented.\"); },\n    sendString: (_message: string, _connectionId: number) => { throw new IModelError(BentleyStatus.ERROR, \"No connection.\"); },\n    sendBinary: (_message: Uint8Array, _connectionId: number) => { throw new IModelError(BentleyStatus.ERROR, \"No connection.\"); },\n    port: 0,\n    connectionId: 0,\n  };\n\n  private _server: ws.Server;\n  private _connection: ws | undefined;\n  private _port: number;\n  private _connectionId: number;\n  private _pingTimer: NodeJS.Timeout;\n  public constructor() {\n    /* _pingTime is a fix for ios/mobile case where when the app moves into foreground from\n     * background backend restart ws.Server and then notify frontend to reconnect. But ws.Server\n     * listening event is not fired as node yield to kevent and wait for some io event to happen.\n     * This causes a delay in reconnection which may be as long a 40 secs. To solve the issue we\n     * create _pingTimer which causes kevent to yield back to uv poll so timer event can be fired.\n     * This allow listening event to go through quickly (max 5ms). Once the listening event occur we\n     * clear the timer. Here we use setInterval() just to make sure otherwise setTimeout() could equally\n     * be effective\n     */\n    this._pingTimer = setInterval(() => { }, 5);\n    this._port = MobileRpcConfiguration.setup.obtainPort();\n    this._server = new ws.Server({ port: this._port });\n    this._connectionId = ++MobileRpcServer._nextId;\n    MobileRpcServer.interop.connectionId = this._connectionId;\n    this._onListening();\n    this._onConnection();\n  }\n\n  private _onListening() {\n    this._server.on(\"listening\", () => {\n      const address = this._server.address() as ws.AddressInfo;\n      this._port = address.port;\n      clearInterval(this._pingTimer);\n      this._notifyListening();\n    });\n  }\n\n  private _notifyListening() {\n    MobileRpcServer.interop.port = this._port;\n\n    if (addon) {\n      addon.notifyListening(this._port);\n    }\n\n    if (this._connectionId !== 0) {\n      MobileHost.reconnect(this._port);\n    }\n  }\n\n  private _onConnection() {\n    this._server.on(\"connection\", (connection) => {\n      this._connection = connection;\n      this._connection.on(\"message\", (data) => this._onConnectionMessage(data));\n      this._createSender();\n      (global as any).__iTwinJsRpcReady = true;\n    });\n  }\n\n  private _createSender() {\n    const sender = (message: string | Uint8Array, connectionId: number) => {\n      if (connectionId !== this._connectionId) {\n        return;\n      }\n\n      this._connection!.send(message, (err) => {\n        if (err) {\n          throw err;\n        }\n      });\n    };\n\n    MobileRpcServer.interop.sendString = sender;\n    MobileRpcServer.interop.sendBinary = sender;\n  }\n\n  private _onConnectionMessage(data: ws.Data) {\n    let message = data;\n    if (Array.isArray(message)) {\n      throw new IModelError(BentleyStatus.ERROR, \"Unsupported data type\");\n    }\n\n    if (Buffer.isBuffer(message)) {\n      if (message.byteOffset !== 0 || message.byteLength !== message.buffer.byteLength) {\n        message = new Uint8Array(message.buffer, message.byteOffset, message.byteLength);\n      } else {\n        message = message.buffer;\n      }\n    }\n\n    MobileRpcServer.interop.handler(message, this._connectionId);\n  }\n\n  public dispose() {\n    clearInterval(this._pingTimer);\n    if (this._connection) {\n      MobileRpcServer.interop.sendString = () => { };\n      MobileRpcServer.interop.sendBinary = () => { };\n      this._connection.close();\n    }\n\n    this._server.close();\n  }\n}\n\nlet mobileReady = false;\nlet hasSuspended = false;\n\nexport function setupMobileRpc() {\n  if (mobileReady) {\n    return;\n  }\n\n  if (ProcessDetector.isMobileAppBackend) {\n    addon = (process as any)._linkedBinding(\"iModelJsMobile\");\n    addon?.registerDeviceImpl();\n  }\n\n  let server: MobileRpcServer | null = new MobileRpcServer();\n\n  /* The UV event loop (internal to node) is retained by handles,\n     such as those created for setInterval/setTimeout and client/server connections.\n     In a simple app, the RPC server may be the only handle retaining the UV loop.\n     Thus, we install a temporary timer on suspend to prevent the loop from exiting prematurely.\n  */\n  let retainUvLoop: NodeJS.Timer | undefined;\n\n  MobileHost.onEnterBackground.addListener(() => {\n    hasSuspended = true;\n\n    if (server === null) {\n      return;\n    }\n\n    retainUvLoop = setInterval(() => { }, 1000);\n    server.dispose();\n    server = null;\n  });\n\n  MobileHost.onEnterForeground.addListener(() => {\n    if (!hasSuspended) {\n      return;\n    }\n\n    server = new MobileRpcServer();\n    clearInterval(retainUvLoop);\n    retainUvLoop = undefined;\n  });\n\n  MobileHost.onWillTerminate.addListener(() => {\n    if (typeof (retainUvLoop) !== \"undefined\") {\n      clearInterval(retainUvLoop);\n      retainUvLoop = undefined;\n    }\n\n    if (server === null) {\n      return;\n    }\n\n    server.dispose();\n    server = null;\n  });\n\n  MobileRpcProtocol.obtainInterop = () => MobileRpcServer.interop;\n  mobileReady = true;\n}\n"]}

package/lib/cjs/backend/Request.d.ts

@@ -1,150 +1,118 @@
-/// <reference types="node" />
-import * as https from "https";
-import { BentleyError, GetMetaDataFunction, HttpStatus } from "@itwin/core-bentley";
-/** @internal */
-export declare const requestIdHeaderName = "X-Correlation-Id";
-/** Typical option to query REST API. Note that services may not quite support these fields,
- * and the interface is only provided as a hint.
- * @internal
- */
-export interface RequestQueryOptions {
-    /**
-     * Select string used by the query (use the mapped EC property names, and not TypeScript property names)
-     * Example: "Name,Size,Description"
-     */
-    $select?: string;
-    /**
-     * Filter string used by the query (use the mapped EC property names, and not TypeScript property names)
-     *  Example: "Name like '*.pdf' and Size lt 1000"
-     */
-    $filter?: string;
-    /** Sets the limit on the number of entries to be returned by the query */
-    $top?: number;
-    /** Sets the number of entries to be skipped */
-    $skip?: number;
-    /**
-     * Orders the return values (use the mapped EC property names, and not TypeScript property names)
-     * Example: "Size desc"
-     */
-    $orderby?: string;
-    /**
-     *  Sets the limit on the number of entries to be returned by a single response.
-     *  Can be used with a Top option. For example if Top is set to 1000 and PageSize
-     *  is set to 100 then 10 requests will be performed to get result.
-     */
-    $pageSize?: number;
-}
-/** @internal */
-export interface RequestQueryStringifyOptions {
-    delimiter?: string;
-    encode?: boolean;
-}
-/** Option to control the time outs
- * Use a short response timeout to detect unresponsive networks quickly, and a long deadline to give time for downloads on slow,
- * but reliable, networks. Note that both of these timers limit how long uploads of attached files are allowed to take. Use long
- * timeouts if you're uploading files.
- * @internal
- */
-export interface RequestTimeoutOptions {
-    /** Sets a deadline (in milliseconds) for the entire request (including all uploads, redirects, server processing time) to complete.
-     * If the response isn't fully downloaded within that time, the request will be aborted
-     */
-    deadline?: number;
-    /** Sets maximum time (in milliseconds) to wait for the first byte to arrive from the server, but it does not limit how long the entire
-     * download can take. Response timeout should be at least few seconds longer than just the time it takes the server to respond, because
-     * it also includes time to make DNS lookup, TCP/IP and TLS connections, and time to upload request data.
-     */
-    response?: number;
-}
-/** @internal */
-export interface RequestOptions {
-    method: string;
-    headers?: any;
-    body?: any;
-    qs?: any | RequestQueryOptions;
-    responseType?: string;
-    timeout?: RequestTimeoutOptions;
-    stream?: any;
-    readStream?: any;
-    buffer?: any;
-    parser?: any;
-    accept?: string;
-    redirects?: number;
-    errorCallback?: (response: any) => ResponseError;
-    retryCallback?: (error: any, response: any) => boolean;
-    progressCallback?: ProgressCallback;
-    agent?: https.Agent;
-    retries?: number;
-    useCorsProxy?: boolean;
-}
-/** Response object if the request was successful. Note that the status within the range of 200-299 are considered as a success.
- * @internal
- */
-export interface Response {
-    body: any;
-    text: string | undefined;
-    header: any;
-    status: number;
-}
-/** @internal */
-export interface ProgressInfo {
-    percent?: number;
-    total?: number;
-    loaded: number;
-}
-/** @internal */
-export declare type ProgressCallback = (progress: ProgressInfo) => void;
-/** Error object that's thrown/rejected if the Request fails due to a network error, or if the status is *not* in the range of 200-299 (inclusive)
- * @internal
- */
-export declare class ResponseError extends BentleyError {
-    protected _data?: any;
-    status?: number;
-    description?: string;
-    constructor(errorNumber: number | HttpStatus, message?: string, getMetaData?: GetMetaDataFunction);
-    /**
-     * Parses error from server's response
-     * @param response Http response from the server.
-     * @returns Parsed error.
-     * @internal
-     */
-    static parse(response: any, log?: boolean): ResponseError;
-    /**
-     * Decides whether request should be retried or not
-     * @param error Error returned by request
-     * @param response Response returned by request
-     * @internal
-     */
-    static shouldRetry(error: any, response: any): boolean;
-    /**
-     * @internal
-     */
-    static parseHttpStatus(statusType: number): HttpStatus;
-    /**
-     * @internal
-     */
-    logMessage(): string;
-    /**
-     * Logs this error
-     * @internal
-     */
-    log(): void;
-}
-/** Wrapper around making HTTP requests with the specific options.
- *
- * Usable in both a browser and node based environment.
- *
- * @param url Server URL to address the request
- * @param options Options to pass to the request
- * @returns Resolves to the response from the server
- * @throws ResponseError if the request fails due to network issues, or if the returned status is *outside* the range of 200-299 (inclusive)
- * @internal
- */
-export declare function request(url: string, options: RequestOptions): Promise<Response>;
-/**
- * fetch json from HTTP request
- * @param url server URL to address the request
- * @internal
- */
-export declare function getJson(url: string): Promise<any>;
+/// <reference types="node" />
+import * as https from "https";
+import { BentleyError, GetMetaDataFunction, HttpStatus } from "@itwin/core-bentley";
+/** @internal */
+export declare const requestIdHeaderName = "X-Correlation-Id";
+/** @internal */
+export interface RequestQueryStringifyOptions {
+    delimiter?: string;
+    encode?: boolean;
+}
+/** Option to control the time outs
+ * Use a short response timeout to detect unresponsive networks quickly, and a long deadline to give time for downloads on slow,
+ * but reliable, networks. Note that both of these timers limit how long uploads of attached files are allowed to take. Use long
+ * timeouts if you're uploading files.
+ * @internal
+ */
+export interface RequestTimeoutOptions {
+    /** Sets a deadline (in milliseconds) for the entire request (including all uploads, redirects, server processing time) to complete.
+     * If the response isn't fully downloaded within that time, the request will be aborted
+     */
+    deadline?: number;
+    /** Sets maximum time (in milliseconds) to wait for the first byte to arrive from the server, but it does not limit how long the entire
+     * download can take. Response timeout should be at least few seconds longer than just the time it takes the server to respond, because
+     * it also includes time to make DNS lookup, TCP/IP and TLS connections, and time to upload request data.
+     */
+    response?: number;
+}
+/** @internal */
+export interface RequestOptions {
+    method: string;
+    headers?: any;
+    body?: any;
+    responseType?: string;
+    timeout?: RequestTimeoutOptions;
+    stream?: any;
+    readStream?: any;
+    buffer?: any;
+    parser?: any;
+    accept?: string;
+    redirects?: number;
+    errorCallback?: (response: any) => ResponseError;
+    retryCallback?: (error: any, response: any) => boolean;
+    progressCallback?: ProgressCallback;
+    agent?: https.Agent;
+    retries?: number;
+    useCorsProxy?: boolean;
+}
+/** Response object if the request was successful. Note that the status within the range of 200-299 are considered as a success.
+ * @internal
+ */
+export interface Response {
+    body: any;
+    text: string | undefined;
+    header: any;
+    status: number;
+}
+/** @internal */
+export interface ProgressInfo {
+    percent?: number;
+    total?: number;
+    loaded: number;
+}
+/** @internal */
+export type ProgressCallback = (progress: ProgressInfo) => void;
+/** Error object that's thrown/rejected if the Request fails due to a network error, or if the status is *not* in the range of 200-299 (inclusive)
+ * @internal
+ */
+export declare class ResponseError extends BentleyError {
+    protected _data?: any;
+    status?: number;
+    description?: string;
+    constructor(errorNumber: number | HttpStatus, message?: string, getMetaData?: GetMetaDataFunction);
+    /**
+     * Parses error from server's response
+     * @param response Http response from the server.
+     * @returns Parsed error.
+     * @internal
+     */
+    static parse(response: any, log?: boolean): ResponseError;
+    /**
+     * Decides whether request should be retried or not
+     * @param error Error returned by request
+     * @param response Response returned by request
+     * @internal
+     */
+    static shouldRetry(error: any, response: any): boolean;
+    /**
+     * @internal
+     */
+    static parseHttpStatus(statusType: number): HttpStatus;
+    /**
+     * @internal
+     */
+    logMessage(): string;
+    /**
+     * Logs this error
+     * @internal
+     */
+    log(): void;
+}
+/** Wrapper around making HTTP requests with the specific options.
+ *
+ * Usable in both a browser and node based environment.
+ *
+ * @param url Server URL to address the request
+ * @param options Options to pass to the request
+ * @returns Resolves to the response from the server
+ * @throws ResponseError if the request fails due to network issues, or if the returned status is *outside* the range of 200-299 (inclusive)
+ * @internal
+ */
+export declare function request(url: string, options: RequestOptions): Promise<Response>;
+/**
+ * fetch json from HTTP request
+ * @param url server URL to address the request
+ * @internal
+ */
+export declare function getJson(url: string): Promise<any>;
 //# sourceMappingURL=Request.d.ts.map