@itwin/core-common 4.0.0-dev.6 → 4.0.0-dev.61

package/lib/esm/rpc/web/WebAppRpcLogging.d.ts

@@ -1,29 +1,29 @@
-/** @packageDocumentation
- * @module RpcInterface
- */
-import { RpcInterfaceDefinition } from "../../RpcInterface";
-import { RpcProtocolEvent } from "../core/RpcConstants";
-import { RpcInvocation } from "../core/RpcInvocation";
-import { RpcOperation } from "../core/RpcOperation";
-import { SerializedRpcOperation, SerializedRpcRequest } from "../core/RpcProtocol";
-import { RpcRequest } from "../core/RpcRequest";
-import { WebAppRpcRequest } from "./WebAppRpcRequest";
-/** @internal */
-export declare abstract class WebAppRpcLogging {
-    static initializeBackend(instance: WebAppRpcLogging): void;
-    static initializeFrontend(instance: WebAppRpcLogging): void;
-    private static get backend();
-    private static get frontend();
-    static logProtocolEvent(event: RpcProtocolEvent, object: RpcRequest | RpcInvocation): Promise<void>;
-    protected abstract logProtocolEvent(event: RpcProtocolEvent, object: RpcRequest | RpcInvocation): Promise<void>;
-    protected abstract getHostname(): string;
-    protected getRpcInterfaceName(g: string | RpcInterfaceDefinition): string;
-    protected findPathIds(path: string): {
-        iTwinId: string;
-        iModelId: string;
-    };
-    protected buildOperationDescriptor(operation: RpcOperation | SerializedRpcOperation): string;
-    protected logRequest(loggerCategory: string, message: string, object: WebAppRpcRequest | SerializedRpcRequest): void;
-    protected logResponse(loggerCategory: string, message: string, object: WebAppRpcRequest | SerializedRpcRequest, status: number, elapsed: number): void;
-}
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { RpcInterfaceDefinition } from "../../RpcInterface";
+import { RpcProtocolEvent } from "../core/RpcConstants";
+import { RpcInvocation } from "../core/RpcInvocation";
+import { RpcOperation } from "../core/RpcOperation";
+import { SerializedRpcOperation, SerializedRpcRequest } from "../core/RpcProtocol";
+import { RpcRequest } from "../core/RpcRequest";
+import { WebAppRpcRequest } from "./WebAppRpcRequest";
+/** @internal */
+export declare abstract class WebAppRpcLogging {
+    static initializeBackend(instance: WebAppRpcLogging): void;
+    static initializeFrontend(instance: WebAppRpcLogging): void;
+    private static get backend();
+    private static get frontend();
+    static logProtocolEvent(event: RpcProtocolEvent, object: RpcRequest | RpcInvocation): Promise<void>;
+    protected abstract logProtocolEvent(event: RpcProtocolEvent, object: RpcRequest | RpcInvocation): Promise<void>;
+    protected abstract getHostname(): string;
+    protected getRpcInterfaceName(g: string | RpcInterfaceDefinition): string;
+    protected findPathIds(path: string): {
+        iTwinId: string;
+        iModelId: string;
+    };
+    protected buildOperationDescriptor(operation: RpcOperation | SerializedRpcOperation): string;
+    protected logRequest(loggerCategory: string, message: string, object: WebAppRpcRequest | SerializedRpcRequest): void;
+    protected logResponse(loggerCategory: string, message: string, object: WebAppRpcRequest | SerializedRpcRequest, status: number, elapsed: number): void;
+}
 //# sourceMappingURL=WebAppRpcLogging.d.ts.map

package/lib/esm/rpc/web/WebAppRpcLogging.js

@@ -1,137 +1,137 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module RpcInterface
- */
-import { BentleyStatus, Logger } from "@itwin/core-bentley";
-import { CommonLoggerCategory } from "../../CommonLoggerCategory";
-import { IModelError } from "../../IModelError";
-import { RpcProtocolEvent } from "../core/RpcConstants";
-import { RpcInvocation } from "../core/RpcInvocation";
-import { WebAppRpcRequest } from "./WebAppRpcRequest";
-/* eslint-disable deprecation/deprecation */
-/** @internal */
-const BACKEND = Symbol.for("@itwin.WebAppRpcLogging.Backend");
-const FRONTEND = Symbol.for("@itwin.WebAppRpcLogging.Frontend");
-/** @internal */
-export class WebAppRpcLogging {
-    static initializeBackend(instance) {
-        globalThis[BACKEND] = instance;
-    }
-    static initializeFrontend(instance) {
-        globalThis[FRONTEND] = instance;
-    }
-    static get backend() {
-        const instance = globalThis[BACKEND];
-        if (typeof (instance) === "undefined") {
-            throw new IModelError(BentleyStatus.ERROR, "Backend logging is not initialized.");
-        }
-        return instance;
-    }
-    static get frontend() {
-        const instance = globalThis[FRONTEND];
-        if (typeof (instance) === "undefined") {
-            throw new IModelError(BentleyStatus.ERROR, "Frontend logging is not initialized.");
-        }
-        return instance;
-    }
-    static async logProtocolEvent(event, object) {
-        if (object instanceof WebAppRpcRequest) {
-            await WebAppRpcLogging.frontend.logProtocolEvent(event, object);
-        }
-        else if (object instanceof RpcInvocation) {
-            await WebAppRpcLogging.backend.logProtocolEvent(event, object);
-        }
-    }
-    getRpcInterfaceName(g) {
-        return (typeof g === "string") ? g : g.interfaceName;
-    }
-    findPathIds(path) {
-        let iTwinId = "";
-        let iModelId = "";
-        const tokens = path.split("/");
-        for (let i = 0; i !== tokens.length; ++i) {
-            // For backwards compatibility, find old "context" or current "iTwin" terminology
-            if ((/^context$/i).test(tokens[i]) || (/^itwin$/i).test(tokens[i])) {
-                iTwinId = tokens[i + 1] || "";
-            }
-            if ((/^imodel$/i).test(tokens[i])) {
-                iModelId = tokens[i + 1] || "";
-            }
-        }
-        return { iTwinId, iModelId };
-    }
-    buildOperationDescriptor(operation) {
-        if (!operation) {
-            return "unknown.unknown";
-        }
-        const interfaceName = typeof (operation.interfaceDefinition) === "string" ? operation.interfaceDefinition : operation.interfaceDefinition.interfaceName;
-        const operationName = operation.operationName;
-        return `${interfaceName}.${operationName}`;
-    }
-    logRequest(loggerCategory, message, object) {
-        const operationDescriptor = this.buildOperationDescriptor(object.operation);
-        const pathIds = this.findPathIds(object.path);
-        Logger.logTrace(loggerCategory, `${message}.${operationDescriptor}`, () => ({
-            method: object.method,
-            path: object.path,
-            operation: object.operation.operationName,
-            rpcInterface: this.getRpcInterfaceName(object.operation.interfaceDefinition),
-            // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!
-            ActivityId: object.id,
-            TimeElapsed: ("elapsed" in object) ? object.elapsed : 0,
-            MachineName: this.getHostname(),
-            ...pathIds,
-        }));
-    }
-    logResponse(loggerCategory, message, object, status, elapsed) {
-        const operationDescriptor = this.buildOperationDescriptor(object.operation);
-        const pathIds = this.findPathIds(object.path);
-        Logger.logTrace(loggerCategory, `${message}.${operationDescriptor}`, () => ({
-            method: object.method,
-            path: object.path,
-            operation: object.operation.operationName,
-            rpcInterface: this.getRpcInterfaceName(object.operation.interfaceDefinition),
-            status,
-            // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!
-            ActivityId: object.id,
-            TimeElapsed: elapsed,
-            MachineName: this.getHostname(),
-            ...pathIds,
-        }));
-    }
-}
-class WebAppRpcLoggingFrontend extends WebAppRpcLogging {
-    async logProtocolEvent(event, object) {
-        switch (event) {
-            case RpcProtocolEvent.RequestCreated: return this.logRequest(CommonLoggerCategory.RpcInterfaceFrontend, "RpcInterface.frontend.request", object);
-            case RpcProtocolEvent.ResponseLoaded: return this.logResponse(CommonLoggerCategory.RpcInterfaceFrontend, "RpcInterface.frontend.response", object, object.metadata.status, object.elapsed);
-            case RpcProtocolEvent.ConnectionErrorReceived: return this.logErrorFrontend("RpcInterface.frontend.connectionError", object);
-            case RpcProtocolEvent.ConnectionAborted: return this.logErrorFrontend("RpcInterface.frontend.connectionAborted", object);
-        }
-    }
-    getHostname() {
-        if (globalThis.window) {
-            return globalThis.window.location.host;
-        }
-        else {
-            return "imodeljs-mobile";
-        }
-    }
-    logErrorFrontend(message, request) {
-        const operationDescriptor = this.buildOperationDescriptor(request.operation);
-        const pathIds = this.findPathIds(request.path);
-        Logger.logInfo(CommonLoggerCategory.RpcInterfaceFrontend, `${message}.${operationDescriptor}`, () => ({
-            method: request.method,
-            path: request.path,
-            // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!
-            ActivityId: request.id,
-            MachineName: this.getHostname(),
-            ...pathIds,
-        }));
-    }
-}
-WebAppRpcLogging.initializeFrontend(new WebAppRpcLoggingFrontend());
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { BentleyStatus, Logger } from "@itwin/core-bentley";
+import { CommonLoggerCategory } from "../../CommonLoggerCategory";
+import { IModelError } from "../../IModelError";
+import { RpcProtocolEvent } from "../core/RpcConstants";
+import { RpcInvocation } from "../core/RpcInvocation";
+import { WebAppRpcRequest } from "./WebAppRpcRequest";
+/* eslint-disable deprecation/deprecation */
+/** @internal */
+const BACKEND = Symbol.for("@itwin.WebAppRpcLogging.Backend");
+const FRONTEND = Symbol.for("@itwin.WebAppRpcLogging.Frontend");
+/** @internal */
+export class WebAppRpcLogging {
+    static initializeBackend(instance) {
+        globalThis[BACKEND] = instance;
+    }
+    static initializeFrontend(instance) {
+        globalThis[FRONTEND] = instance;
+    }
+    static get backend() {
+        const instance = globalThis[BACKEND];
+        if (typeof (instance) === "undefined") {
+            throw new IModelError(BentleyStatus.ERROR, "Backend logging is not initialized.");
+        }
+        return instance;
+    }
+    static get frontend() {
+        const instance = globalThis[FRONTEND];
+        if (typeof (instance) === "undefined") {
+            throw new IModelError(BentleyStatus.ERROR, "Frontend logging is not initialized.");
+        }
+        return instance;
+    }
+    static async logProtocolEvent(event, object) {
+        if (object instanceof WebAppRpcRequest) {
+            await WebAppRpcLogging.frontend.logProtocolEvent(event, object);
+        }
+        else if (object instanceof RpcInvocation) {
+            await WebAppRpcLogging.backend.logProtocolEvent(event, object);
+        }
+    }
+    getRpcInterfaceName(g) {
+        return (typeof g === "string") ? g : g.interfaceName;
+    }
+    findPathIds(path) {
+        let iTwinId = "";
+        let iModelId = "";
+        const tokens = path.split("/");
+        for (let i = 0; i !== tokens.length; ++i) {
+            // For backwards compatibility, find old "context" or current "iTwin" terminology
+            if ((/^context$/i).test(tokens[i]) || (/^itwin$/i).test(tokens[i])) {
+                iTwinId = tokens[i + 1] || "";
+            }
+            if ((/^imodel$/i).test(tokens[i])) {
+                iModelId = tokens[i + 1] || "";
+            }
+        }
+        return { iTwinId, iModelId };
+    }
+    buildOperationDescriptor(operation) {
+        if (!operation) {
+            return "unknown.unknown";
+        }
+        const interfaceName = typeof (operation.interfaceDefinition) === "string" ? operation.interfaceDefinition : operation.interfaceDefinition.interfaceName;
+        const operationName = operation.operationName;
+        return `${interfaceName}.${operationName}`;
+    }
+    logRequest(loggerCategory, message, object) {
+        const operationDescriptor = this.buildOperationDescriptor(object.operation);
+        const pathIds = this.findPathIds(object.path);
+        Logger.logTrace(loggerCategory, `${message}.${operationDescriptor}`, () => ({
+            method: object.method,
+            path: object.path,
+            operation: object.operation.operationName,
+            rpcInterface: this.getRpcInterfaceName(object.operation.interfaceDefinition),
+            // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!
+            ActivityId: object.id,
+            TimeElapsed: ("elapsed" in object) ? object.elapsed : 0,
+            MachineName: this.getHostname(),
+            ...pathIds,
+        }));
+    }
+    logResponse(loggerCategory, message, object, status, elapsed) {
+        const operationDescriptor = this.buildOperationDescriptor(object.operation);
+        const pathIds = this.findPathIds(object.path);
+        Logger.logTrace(loggerCategory, `${message}.${operationDescriptor}`, () => ({
+            method: object.method,
+            path: object.path,
+            operation: object.operation.operationName,
+            rpcInterface: this.getRpcInterfaceName(object.operation.interfaceDefinition),
+            status,
+            // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!
+            ActivityId: object.id,
+            TimeElapsed: elapsed,
+            MachineName: this.getHostname(),
+            ...pathIds,
+        }));
+    }
+}
+class WebAppRpcLoggingFrontend extends WebAppRpcLogging {
+    async logProtocolEvent(event, object) {
+        switch (event) {
+            case RpcProtocolEvent.RequestCreated: return this.logRequest(CommonLoggerCategory.RpcInterfaceFrontend, "RpcInterface.frontend.request", object);
+            case RpcProtocolEvent.ResponseLoaded: return this.logResponse(CommonLoggerCategory.RpcInterfaceFrontend, "RpcInterface.frontend.response", object, object.metadata.status, object.elapsed);
+            case RpcProtocolEvent.ConnectionErrorReceived: return this.logErrorFrontend("RpcInterface.frontend.connectionError", object);
+            case RpcProtocolEvent.ConnectionAborted: return this.logErrorFrontend("RpcInterface.frontend.connectionAborted", object);
+        }
+    }
+    getHostname() {
+        if (globalThis.window) {
+            return globalThis.window.location.host;
+        }
+        else {
+            return "imodeljs-mobile";
+        }
+    }
+    logErrorFrontend(message, request) {
+        const operationDescriptor = this.buildOperationDescriptor(request.operation);
+        const pathIds = this.findPathIds(request.path);
+        Logger.logInfo(CommonLoggerCategory.RpcInterfaceFrontend, `${message}.${operationDescriptor}`, () => ({
+            method: request.method,
+            path: request.path,
+            // Alert! The following properties are required by Bentley DevOps standards. Do not change their names!
+            ActivityId: request.id,
+            MachineName: this.getHostname(),
+            ...pathIds,
+        }));
+    }
+}
+WebAppRpcLogging.initializeFrontend(new WebAppRpcLoggingFrontend());
 //# sourceMappingURL=WebAppRpcLogging.js.map

package/lib/esm/rpc/web/WebAppRpcProtocol.d.ts

@@ -1,90 +1,90 @@
-/** @packageDocumentation
- * @module RpcInterface
- */
-/// <reference types="node" />
-import { BackendReadable, BackendWritable } from "../../BackendTypes";
-import { RpcConfiguration } from "../core/RpcConfiguration";
-import { RpcContentType, RpcRequestStatus } from "../core/RpcConstants";
-import { RpcOperation } from "../core/RpcOperation";
-import { RpcProtocol } from "../core/RpcProtocol";
-import { OpenAPIInfo, OpenAPIParameter, RpcOpenAPIDescription } from "./OpenAPI";
-import { WebAppRpcRequest } from "./WebAppRpcRequest";
-/** An HTTP server request object.
- * @public
- * @deprecated in 3.6. The RPC system will be significantly refactored (or replaced) in version 5.0.
- */
-export interface HttpServerRequest extends BackendReadable {
-    aborted: boolean;
-    httpVersion: string;
-    httpVersionMajor: number;
-    httpVersionMinor: number;
-    complete: boolean;
-    connection: any;
-    headers: {
-        [header: string]: string | string[] | undefined;
-    };
-    rawHeaders: string[];
-    trailers: {
-        [key: string]: string | undefined;
-    };
-    rawTrailers: string[];
-    setTimeout(msecs: number, callback: () => void): void;
-    setTimeout(msecs: number, callback: () => void): this;
-    url?: string;
-    statusCode?: number;
-    statusMessage?: string;
-    socket: any;
-    destroy(error?: Error): this;
-    body: string | Buffer;
-    path: string;
-    method: string;
-    ip?: string;
-    header: (field: string) => string | undefined;
-}
-/** An HTTP server response object.
- * @public
- * @deprecated in 3.6. The RPC system will be significantly refactored (or replaced) in version 5.0.
- */
-export interface HttpServerResponse extends BackendWritable {
-    send(body?: any): HttpServerResponse;
-    status(code: number): HttpServerResponse;
-    set(field: string, value: string): void;
-}
-/** The HTTP application protocol.
- * @internal
- */
-export declare abstract class WebAppRpcProtocol extends RpcProtocol {
-    preserveStreams: boolean;
-    /** Convenience handler for an RPC operation get request for an HTTP server. */
-    handleOperationGetRequest(req: HttpServerRequest, res: HttpServerResponse): Promise<void>;
-    /** Convenience handler for an RPC operation post request for an HTTP server. */
-    handleOperationPostRequest(req: HttpServerRequest, res: HttpServerResponse): Promise<void>;
-    /** Convenience handler for an OpenAPI description request for an HTTP server. */
-    handleOpenApiDescriptionRequest(_req: HttpServerRequest, res: HttpServerResponse): void;
-    /** Converts an HTTP content type value to an RPC content type value. */
-    static computeContentType(httpType: string | null | undefined): RpcContentType;
-    /** The OpenAPI-compatible info object for this protocol. */
-    abstract info: OpenAPIInfo;
-    /** An optional prefix for RPC operation URI paths. */
-    pathPrefix: string;
-    /** The RPC request class for this protocol. */
-    readonly requestType: typeof WebAppRpcRequest;
-    /** Supplies the status corresponding to a protocol-specific code value. */
-    getStatus(code: number): RpcRequestStatus;
-    /** Supplies the protocol-specific code corresponding to a status value. */
-    getCode(status: RpcRequestStatus): number;
-    supportsStatusCategory: boolean;
-    /** Whether an HTTP status code indicates a request timeout. */
-    isTimeout(code: number): boolean;
-    /** An OpenAPI-compatible description of this protocol.
-     * @internal
-     */
-    get openAPIDescription(): RpcOpenAPIDescription;
-    /** Returns the OpenAPI-compatible URI path parameters for an RPC operation.
-     * @internal
-     */
-    abstract supplyPathParametersForOperation(_operation: RpcOperation): OpenAPIParameter[];
-    /** Constructs an HTTP protocol. */
-    constructor(configuration: RpcConfiguration);
-}
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+/// <reference types="node" />
+import { BackendReadable, BackendWritable } from "../../BackendTypes";
+import { RpcConfiguration } from "../core/RpcConfiguration";
+import { RpcContentType, RpcRequestStatus } from "../core/RpcConstants";
+import { RpcOperation } from "../core/RpcOperation";
+import { RpcProtocol } from "../core/RpcProtocol";
+import { OpenAPIInfo, OpenAPIParameter, RpcOpenAPIDescription } from "./OpenAPI";
+import { WebAppRpcRequest } from "./WebAppRpcRequest";
+/** An HTTP server request object.
+ * @public
+ * @deprecated in 3.6. The RPC system will be significantly refactored (or replaced) in version 5.0.
+ */
+export interface HttpServerRequest extends BackendReadable {
+    aborted: boolean;
+    httpVersion: string;
+    httpVersionMajor: number;
+    httpVersionMinor: number;
+    complete: boolean;
+    connection: any;
+    headers: {
+        [header: string]: string | string[] | undefined;
+    };
+    rawHeaders: string[];
+    trailers: {
+        [key: string]: string | undefined;
+    };
+    rawTrailers: string[];
+    setTimeout(msecs: number, callback: () => void): void;
+    setTimeout(msecs: number, callback: () => void): this;
+    url?: string;
+    statusCode?: number;
+    statusMessage?: string;
+    socket: any;
+    destroy(error?: Error): this;
+    body: string | Buffer;
+    path: string;
+    method: string;
+    ip?: string;
+    header: (field: string) => string | undefined;
+}
+/** An HTTP server response object.
+ * @public
+ * @deprecated in 3.6. The RPC system will be significantly refactored (or replaced) in version 5.0.
+ */
+export interface HttpServerResponse extends BackendWritable {
+    send(body?: any): HttpServerResponse;
+    status(code: number): HttpServerResponse;
+    set(field: string, value: string): void;
+}
+/** The HTTP application protocol.
+ * @internal
+ */
+export declare abstract class WebAppRpcProtocol extends RpcProtocol {
+    preserveStreams: boolean;
+    /** Convenience handler for an RPC operation get request for an HTTP server. */
+    handleOperationGetRequest(req: HttpServerRequest, res: HttpServerResponse): Promise<void>;
+    /** Convenience handler for an RPC operation post request for an HTTP server. */
+    handleOperationPostRequest(req: HttpServerRequest, res: HttpServerResponse): Promise<void>;
+    /** Convenience handler for an OpenAPI description request for an HTTP server. */
+    handleOpenApiDescriptionRequest(_req: HttpServerRequest, res: HttpServerResponse): void;
+    /** Converts an HTTP content type value to an RPC content type value. */
+    static computeContentType(httpType: string | null | undefined): RpcContentType;
+    /** The OpenAPI-compatible info object for this protocol. */
+    abstract info: OpenAPIInfo;
+    /** An optional prefix for RPC operation URI paths. */
+    pathPrefix: string;
+    /** The RPC request class for this protocol. */
+    readonly requestType: typeof WebAppRpcRequest;
+    /** Supplies the status corresponding to a protocol-specific code value. */
+    getStatus(code: number): RpcRequestStatus;
+    /** Supplies the protocol-specific code corresponding to a status value. */
+    getCode(status: RpcRequestStatus): number;
+    supportsStatusCategory: boolean;
+    /** Whether an HTTP status code indicates a request timeout. */
+    isTimeout(code: number): boolean;
+    /** An OpenAPI-compatible description of this protocol.
+     * @internal
+     */
+    get openAPIDescription(): RpcOpenAPIDescription;
+    /** Returns the OpenAPI-compatible URI path parameters for an RPC operation.
+     * @internal
+     */
+    abstract supplyPathParametersForOperation(_operation: RpcOperation): OpenAPIParameter[];
+    /** Constructs an HTTP protocol. */
+    constructor(configuration: RpcConfiguration);
+}
 //# sourceMappingURL=WebAppRpcProtocol.d.ts.map