@itwin/core-mobile 4.0.0-dev.1 → 4.0.0-dev.100

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

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

@@ -1 +1 @@
-{"version":3,"file":"Request.d.ts","sourceRoot":"","sources":["../../../src/backend/Request.ts"],"names":[],"mappings":";AASA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,UAAU,EAAoB,MAAM,qBAAqB,CAAC;AAItG,gBAAgB;AAChB,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAEtD;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,0EAA0E;IAC1E,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,+CAA+C;IAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,gBAAgB;AAChB,MAAM,WAAW,4BAA4B;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,gBAAgB;AAChB,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,EAAE,CAAC,EAAE,GAAG,GAAG,mBAAmB,CAAC;IAC/B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,qBAAqB,CAAC;IAChC,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,UAAU,CAAC,EAAE,GAAG,CAAC;IACjB,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,KAAK,aAAa,CAAC;IACjD,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,KAAK,OAAO,CAAC;IACvD,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,KAAK,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,GAAG,CAAC;IACV,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,MAAM,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,gBAAgB;AAChB,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,gBAAgB;AAChB,oBAAY,gBAAgB,GAAG,CAAC,QAAQ,EAAE,YAAY,KAAK,IAAI,CAAC;AAEhE;;GAEG;AACH,qBAAa,aAAc,SAAQ,YAAY;IAC7C,SAAS,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;gBACT,WAAW,EAAE,MAAM,GAAG,UAAU,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,mBAAmB;IAIxG;;;;;OAKG;WACW,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,GAAG,UAAO,GAAG,aAAa;IAiC7D;;;;;OAKG;WACW,WAAW,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,GAAG,OAAO;IAS7D;;OAEG;WACW,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU;IAiB7D;;OAEG;IACI,UAAU,IAAI,MAAM;IAI3B;;;OAGG;IACI,GAAG,IAAI,IAAI;CAGnB;AAcD;;;;;;;;;GASG;AACH,wBAAsB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CA8IrF;AAED;;;;GAIG;AACH,wBAAsB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAOvD"}
+{"version":3,"file":"Request.d.ts","sourceRoot":"","sources":["../../../src/backend/Request.ts"],"names":[],"mappings":";AAQA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,UAAU,EAAoB,MAAM,qBAAqB,CAAC;AAItG,gBAAgB;AAChB,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAEtD,gBAAgB;AAChB,MAAM,WAAW,4BAA4B;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,gBAAgB;AAChB,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,qBAAqB,CAAC;IAChC,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,UAAU,CAAC,EAAE,GAAG,CAAC;IACjB,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,KAAK,aAAa,CAAC;IACjD,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,KAAK,OAAO,CAAC;IACvD,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,KAAK,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,GAAG,CAAC;IACV,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,MAAM,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,gBAAgB;AAChB,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,gBAAgB;AAChB,MAAM,MAAM,gBAAgB,GAAG,CAAC,QAAQ,EAAE,YAAY,KAAK,IAAI,CAAC;AAEhE;;GAEG;AACH,qBAAa,aAAc,SAAQ,YAAY;IAC7C,SAAS,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;gBACT,WAAW,EAAE,MAAM,GAAG,UAAU,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,mBAAmB;IAIxG;;;;;OAKG;WACW,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,GAAG,UAAO,GAAG,aAAa;IAiC7D;;;;;OAKG;WACW,WAAW,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,GAAG,OAAO;IAS7D;;OAEG;WACW,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU;IAiB7D;;OAEG;IACI,UAAU,IAAI,MAAM;IAI3B;;;OAGG;IACI,GAAG,IAAI,IAAI;CAGnB;AAcD;;;;;;;;;GASG;AACH,wBAAsB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CAmIrF;AAED;;;;GAIG;AACH,wBAAsB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAOvD"}